# Автоматизации

> REST API раздела «Автоматизации»: 32 операции.

Базовый адрес: `https://api.legalstack.ru`. Спецификация: [openapi/automations.json](https://docs.legalstack.ru/openapi/automations.json).

- [Настройка и запуск](https://docs.legalstack.ru/api/automations/automation): Автоматизации: конструктор и запуск.
- [Внешние триггеры](https://docs.legalstack.ru/api/automations/automation-webhook): Внешние вебхук-триггеры автоматизаций.
- [Процессы](https://docs.legalstack.ru/api/automations/automation-workflow): Управление процессами автоматизаций.

## Операции

Всего операций: 32. У каждой операции своя страница со схемами запроса и ответа и примерами вызова.

### [Настройка и запуск](https://docs.legalstack.ru/api/automations/automation)

| Метод | Путь | Операция |
| --- | --- | --- |
| `GET` | `/api/v1/automations` | [Список автоматизаций](https://docs.legalstack.ru/api/automations/automation/get-automations) |
| `POST` | `/api/v1/automations` | [Создать автоматизацию](https://docs.legalstack.ru/api/automations/automation/post-automations) |
| `GET` | `/api/v1/automations/resources/{type}` | [Варианты выбора ресурса для настроек автоматизации](https://docs.legalstack.ru/api/automations/automation/get-automations-resources-type) |
| `GET` | `/api/v1/automations/resources/{type}/{id}/preview` | [Поля ресурса, доступные как данные в автоматизации](https://docs.legalstack.ru/api/automations/automation/get-automations-resources-type-id-preview) |
| `DELETE` | `/api/v1/automations/{id}` | [Удалить автоматизацию](https://docs.legalstack.ru/api/automations/automation/delete-automations-id) |
| `GET` | `/api/v1/automations/{id}` | [Получить автоматизацию](https://docs.legalstack.ru/api/automations/automation/get-automations-id) |
| `PUT` | `/api/v1/automations/{id}` | [Обновить автоматизацию](https://docs.legalstack.ru/api/automations/automation/put-automations-id) |
| `POST` | `/api/v1/automations/{id}/activate` | [Активировать автоматизацию](https://docs.legalstack.ru/api/automations/automation/post-automations-id-activate) |
| `POST` | `/api/v1/automations/{id}/deactivate` | [Деактивировать автоматизацию](https://docs.legalstack.ru/api/automations/automation/post-automations-id-deactivate) |
| `GET` | `/api/v1/automations/{id}/health` | [Устойчивость и узкие места автоматизации](https://docs.legalstack.ru/api/automations/automation/get-automations-id-health) |
| `POST` | `/api/v1/automations/{id}/run` | [Запустить автоматизацию вручную](https://docs.legalstack.ru/api/automations/automation/post-automations-id-run) |
| `GET` | `/api/v1/automations/{id}/runs` | [История прогонов автоматизации](https://docs.legalstack.ru/api/automations/automation/get-automations-id-runs) |
| `DELETE` | `/api/v1/automations/{id}/trigger-sample` | [Сбросить ручной образец данных триггера](https://docs.legalstack.ru/api/automations/automation/delete-automations-id-trigger-sample) |
| `PUT` | `/api/v1/automations/{id}/trigger-sample` | [Задать образец данных триггера для тест-прогона](https://docs.legalstack.ru/api/automations/automation/put-automations-id-trigger-sample) |

### [Внешние триггеры](https://docs.legalstack.ru/api/automations/automation-webhook)

| Метод | Путь | Операция |
| --- | --- | --- |
| `GET` | `/api/v1/automation/webhook/{automationId}` | [Запустить автоматизацию через вебхук (GET, секрет в заголовке x-webhook-secret)](https://docs.legalstack.ru/api/automations/automation-webhook/get-automation-webhook-automationid) |
| `POST` | `/api/v1/automation/webhook/{automationId}` | [Запустить автоматизацию через вебхук (POST, секрет в заголовке x-webhook-secret)](https://docs.legalstack.ru/api/automations/automation-webhook/post-automation-webhook-automationid) |
| `GET` | `/api/v1/automation/webhook/{automationId}/{secretToken}` | [Запустить автоматизацию через вебхук (GET, секрет в адресе)](https://docs.legalstack.ru/api/automations/automation-webhook/get-automation-webhook-automationid-secrettoken) |
| `POST` | `/api/v1/automation/webhook/{automationId}/{secretToken}` | [Запустить автоматизацию через вебхук (POST, секрет в адресе)](https://docs.legalstack.ru/api/automations/automation-webhook/post-automation-webhook-automationid-secrettoken) |

### [Процессы](https://docs.legalstack.ru/api/automations/automation-workflow)

| Метод | Путь | Операция |
| --- | --- | --- |
| `GET` | `/api/v1/workflows` | [Список процессов](https://docs.legalstack.ru/api/automations/automation-workflow/get-workflows) |
| `POST` | `/api/v1/workflows` | [Создать процесс](https://docs.legalstack.ru/api/automations/automation-workflow/post-workflows) |
| `GET` | `/api/v1/workflows/active` | [Активные процессы](https://docs.legalstack.ru/api/automations/automation-workflow/get-workflows-active) |
| `GET` | `/api/v1/workflows/document/{documentId}` | [Процессы, связанные с документом](https://docs.legalstack.ru/api/automations/automation-workflow/get-workflows-document-documentid) |
| `GET` | `/api/v1/workflows/overdue` | [Просроченные процессы](https://docs.legalstack.ru/api/automations/automation-workflow/get-workflows-overdue) |
| `GET` | `/api/v1/workflows/templates/available` | [Шаблоны процессов](https://docs.legalstack.ru/api/automations/automation-workflow/get-workflows-templates-available) |
| `POST` | `/api/v1/workflows/templates/{templateName}` | [Создать процесс из шаблона](https://docs.legalstack.ru/api/automations/automation-workflow/post-workflows-templates-templatename) |
| `DELETE` | `/api/v1/workflows/{id}` | [Удалить процесс](https://docs.legalstack.ru/api/automations/automation-workflow/delete-workflows-id) |
| `GET` | `/api/v1/workflows/{id}` | [Получить процесс](https://docs.legalstack.ru/api/automations/automation-workflow/get-workflows-id) |
| `PUT` | `/api/v1/workflows/{id}` | [Обновить процесс](https://docs.legalstack.ru/api/automations/automation-workflow/put-workflows-id) |
| `POST` | `/api/v1/workflows/{id}/cancel` | [Отменить процесс](https://docs.legalstack.ru/api/automations/automation-workflow/post-workflows-id-cancel) |
| `POST` | `/api/v1/workflows/{id}/pause` | [Приостановить процесс](https://docs.legalstack.ru/api/automations/automation-workflow/post-workflows-id-pause) |
| `POST` | `/api/v1/workflows/{id}/resume` | [Возобновить процесс](https://docs.legalstack.ru/api/automations/automation-workflow/post-workflows-id-resume) |
| `POST` | `/api/v1/workflows/{id}/start` | [Запустить процесс](https://docs.legalstack.ru/api/automations/automation-workflow/post-workflows-id-start) |