Автоматизации
REST API раздела «Автоматизации»: 32 операции.
Базовый адрес: https://api.legalstack.ru. Спецификация: openapi/automations.json.
Настройка и запуск
Автоматизации: конструктор и запуск.
Внешние триггеры
Внешние вебхук-триггеры автоматизаций.
Процессы
Управление процессами автоматизаций.
Операции
Всего операций: 32. У каждой операции своя страница со схемами запроса и ответа и примерами вызова.
Настройка и запуск
| Метод | Путь | Операция |
|---|---|---|
GET | /api/v1/automations | Список автоматизаций |
POST | /api/v1/automations | Создать автоматизацию |
GET | /api/v1/automations/resources/{type} | Варианты выбора ресурса для настроек автоматизации |
GET | /api/v1/automations/resources/{type}/{id}/preview | Поля ресурса, доступные как данные в автоматизации |
DELETE | /api/v1/automations/{id} | Удалить автоматизацию |
GET | /api/v1/automations/{id} | Получить автоматизацию |
PUT | /api/v1/automations/{id} | Обновить автоматизацию |
POST | /api/v1/automations/{id}/activate | Активировать автоматизацию |
POST | /api/v1/automations/{id}/deactivate | Деактивировать автоматизацию |
GET | /api/v1/automations/{id}/health | Устойчивость и узкие места автоматизации |
POST | /api/v1/automations/{id}/run | Запустить автоматизацию вручную |
GET | /api/v1/automations/{id}/runs | История прогонов автоматизации |
DELETE | /api/v1/automations/{id}/trigger-sample | Сбросить ручной образец данных триггера |
PUT | /api/v1/automations/{id}/trigger-sample | Задать образец данных триггера для тест-прогона |
Внешние триггеры
| Метод | Путь | Операция |
|---|---|---|
GET | /api/v1/automation/webhook/{automationId} | Запустить автоматизацию через вебхук (GET, секрет в заголовке x-webhook-secret) |
POST | /api/v1/automation/webhook/{automationId} | Запустить автоматизацию через вебхук (POST, секрет в заголовке x-webhook-secret) |
GET | /api/v1/automation/webhook/{automationId}/{secretToken} | Запустить автоматизацию через вебхук (GET, секрет в адресе) |
POST | /api/v1/automation/webhook/{automationId}/{secretToken} | Запустить автоматизацию через вебхук (POST, секрет в адресе) |
Процессы
| Метод | Путь | Операция |
|---|---|---|
GET | /api/v1/workflows | Список процессов |
POST | /api/v1/workflows | Создать процесс |
GET | /api/v1/workflows/active | Активные процессы |
GET | /api/v1/workflows/document/{documentId} | Процессы, связанные с документом |
GET | /api/v1/workflows/overdue | Просроченные процессы |
GET | /api/v1/workflows/templates/available | Шаблоны процессов |
POST | /api/v1/workflows/templates/{templateName} | Создать процесс из шаблона |
DELETE | /api/v1/workflows/{id} | Удалить процесс |
GET | /api/v1/workflows/{id} | Получить процесс |
PUT | /api/v1/workflows/{id} | Обновить процесс |
POST | /api/v1/workflows/{id}/cancel | Отменить процесс |
POST | /api/v1/workflows/{id}/pause | Приостановить процесс |
POST | /api/v1/workflows/{id}/resume | Возобновить процесс |
POST | /api/v1/workflows/{id}/start | Запустить процесс |