Svaya / Документация / Программный интерфейс
Процессы и задания
Здесь собраны адреса, параметры, поля запросов и коды ответов раздела «Процессы и задания». Каждая операция описана отдельно, с таблицами полей.
Список/поиск процессов (фильтры пакет/версия/маршрут/статус/субъект/период; курсор)
GET /api/core/v1/processes
Параметры
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
packageId (в запросе) | string | нет | |
packageVersion (в запросе) | string | нет | |
routeId (в запросе) | string | нет | |
status (в запросе) | string | нет | |
subject (в запросе) | string | нет | |
cursor (в запросе) | string | нет | |
trial (в запросе) | boolean | нет |
Ответы
200. OK
Поля ответа
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
items | object[] | нет | |
items[].id | string | нет | |
items[].packageId | string | нет | |
items[].packageVersion | string | нет | |
items[].routeId | string | нет | |
items[].status | string | нет | Значения: running, waiting_gate, suspended, compensating, completed, cancelled, compensated, failed, compensation_failed. |
items[].waiting | string | null | нет | Значения: step, backoff, timer, gate, event. |
items[].createdAt | integer | нет | |
items[].finishedAt | integer | null | нет | |
items[].failureReason | string | null | нет | |
items[].queue | object | нет | |
items[].queue.priority | integer | да | 1 «Срочный», 2 «Обычный», 3 «Фоновый» Значения: 1, 2, 3. |
items[].queue.requestClass | string | да | класс обращений процесса к модели: «живой» или «фоновый» Значения: interactive, background. |
items[].queue.waitingFor | string | null | нет | почему задание ещё не исполняется (только getProcess); null — не ждёт Значения: turn, window, limit, capacity. |
items[].queue.until | integer | null | нет | мс эпохи: открытие окна или момент повтора; waitingFor window при null — окна правил не пересекаются |
items[].result | object | null | нет | |
items[].result.outcome | string | да | идентификатор узла-конца маршрута верхнего уровня (код итога) |
items[].result.title | string | да | название итога: снимок title узла-конца на момент завершения |
items[].result.data | object | null | нет | поля, объявленные end.output маршрута; null — данные больше 65 536 байт (тогда dataTruncated: true) |
items[].result.dataTruncated | boolean | нет | данные результата не помещаются в предел 65 536 байт UTF-8 и не отдаются |
items[].trial | boolean | нет | |
items[].trialStop | object | null | нет | |
items[].trialStop.nodeId | string | да | |
items[].trialStop.connectorId | string | да | |
items[].trialStop.tool | string | да | |
items[].traceId | string | нет | |
items[].activeNodes | object[] | нет | Активные узлы: узел активен, пока у него есть незавершённая задача. |
items[].activeNodes[].nodeId | string | да | |
items[].activeNodes[].branch | string | да | ветвь (branchPath); пустая строка — корень |
items[].activeNodes[].kind | string | да | Значения: node, compensation, timer. |
items[].activeNodes[].attempt | integer | да | |
items[].activeNodes[].runAfter | integer | да | epoch ms; в будущем — отложенный повтор |
items[].activeBranches | string[] | нет | |
items[].journal | object | нет | Журнал целиком — `GET /processes/{id}/journal`. |
items[].journal.entries | integer | да | |
items[].journal.lastEvent | string | null | да | |
items[].journal.lastNodeId | string | null | да | |
items[].journal.lastAt | integer | null | да | |
nextCursor | string | null | нет |
Постановка процесса
POST /api/core/v1/processes
Параметры
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
Idempotency-Key (заголовок) | string | да |
Поля тела запроса
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
packageId | string | да | |
packageVersion | string | да | |
routeId | string | да | |
input | any | да | |
subject | object | да | |
subject.id | string | да | |
subject.class | string | да | Значения: staff, service, public. |
channel | string | да | Значения: staff, service, public. |
ownershipAttrs | object | нет | |
trial | boolean | нет | |
overlayVersion | integer | нет | |
trialDecisions | object | нет | |
trialComments | object | нет |
Ответы
201. Создан
Поля ответа
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
processId | string | нет | |
deduplicated | boolean | нет |
403. Ошибка RFC 9457
409. Ошибка RFC 9457
422. Ошибка RFC 9457
Статус + подстатус waiting, активные узлы/ветви, ссылка на трассу
GET /api/core/v1/processes/{id}
Параметры
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
id (в адресе) | string (uuid) | да |
Ответы
200. OK
Поля ответа
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
id | string | нет | |
packageId | string | нет | |
packageVersion | string | нет | |
routeId | string | нет | |
status | string | нет | Значения: running, waiting_gate, suspended, compensating, completed, cancelled, compensated, failed, compensation_failed. |
waiting | string | null | нет | Значения: step, backoff, timer, gate, event. |
createdAt | integer | нет | |
finishedAt | integer | null | нет | |
failureReason | string | null | нет | |
queue | object | нет | |
queue.priority | integer | да | 1 «Срочный», 2 «Обычный», 3 «Фоновый» Значения: 1, 2, 3. |
queue.requestClass | string | да | класс обращений процесса к модели: «живой» или «фоновый» Значения: interactive, background. |
queue.waitingFor | string | null | нет | почему задание ещё не исполняется (только getProcess); null — не ждёт Значения: turn, window, limit, capacity. |
queue.until | integer | null | нет | мс эпохи: открытие окна или момент повтора; waitingFor window при null — окна правил не пересекаются |
result | object | null | нет | |
result.outcome | string | да | идентификатор узла-конца маршрута верхнего уровня (код итога) |
result.title | string | да | название итога: снимок title узла-конца на момент завершения |
result.data | object | null | нет | поля, объявленные end.output маршрута; null — данные больше 65 536 байт (тогда dataTruncated: true) |
result.dataTruncated | boolean | нет | данные результата не помещаются в предел 65 536 байт UTF-8 и не отдаются |
trial | boolean | нет | |
trialStop | object | null | нет | |
trialStop.nodeId | string | да | |
trialStop.connectorId | string | да | |
trialStop.tool | string | да | |
traceId | string | нет | |
activeNodes | object[] | нет | Активные узлы: узел активен, пока у него есть незавершённая задача. |
activeNodes[].nodeId | string | да | |
activeNodes[].branch | string | да | ветвь (branchPath); пустая строка — корень |
activeNodes[].kind | string | да | Значения: node, compensation, timer. |
activeNodes[].attempt | integer | да | |
activeNodes[].runAfter | integer | да | epoch ms; в будущем — отложенный повтор |
activeBranches | string[] | нет | |
journal | object | нет | Журнал целиком — `GET /processes/{id}/journal`. |
journal.entries | integer | да | |
journal.lastEvent | string | null | да | |
journal.lastNodeId | string | null | да | |
journal.lastAt | integer | null | да |
404. Ошибка RFC 9457
getProcessJournal
GET /api/core/v1/processes/{id}/journal
Параметры
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
id (в адресе) | string (uuid) | да | |
cursor (в запросе) | string | нет |
Ответы
200. OK
История кругов гейтов процесса (включая авто-исходы resolvedBy:auto)
GET /api/core/v1/processes/{id}/gates
Параметры
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
id (в адресе) | string (uuid) | да | |
cursor (в запросе) | string | нет |
Ответы
200. OK
Ожидания узла «Ждать» процесса (блок 3) — ключи соотнесения, срок, напоминания, исход
GET /api/core/v1/processes/{id}/waits
Параметры
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
id (в адресе) | string (uuid) | да |
Ответы
200. OK
404. Ошибка RFC 9457
Закрыть ожидание узла «Ждать» извне исходом из объявленных (оператор, внешняя система)
POST /api/core/v1/processes/{id}/waits/{waitId}:signal
Параметры
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
id (в адресе) | string (uuid) | да | |
waitId (в адресе) | string (uuid) | да | |
Idempotency-Key (заголовок) | string | да |
Поля тела запроса
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
outcome | string | да | replied | event | timeout — из объявленных ожиданием |
payload | object | нет | тело события — уходит в результат узла рядом с исходом |
Ответы
204. Ожидание закрыто
404. Ошибка RFC 9457
409. Ошибка RFC 9457
422. Ошибка RFC 9457
cancelProcess
POST /api/core/v1/processes/{id}:cancel
Параметры
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
id (в адресе) | string (uuid) | да | |
Idempotency-Key (заголовок) | string | да |
Поля тела запроса
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
reason | string | да |
Ответы
204. Отменён
409. Ошибка RFC 9457
Оценка ответа прогона получившим его («помог / не помог»; повтор с другим значением — замена)
POST /api/core/v1/processes/{id}:rate
Параметры
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
id (в адресе) | string (uuid) | да | |
Idempotency-Key (заголовок) | string | да |
Поля тела запроса
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
rating | string | да | сторона двусторонней шкалы (bm.feedback.rating) Значения: helpful, not-helpful. |
answerId | string | нет | Какой ответ прогона оценён (прогон может выдать несколько). Пусто — ответ прогона в целом. Только у rateProcessAnswer; у карточки гейта ответ — сам гейт. Дашборд считает ПОСЛЕДНЮЮ оценку на прогон, а не на ответ: разные ответы одного прогона в CSAT не разделяются. |
Ответы
200. Оценка сохранена
Поля ответа
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
processId | string | да | |
answerId | string | да | |
rating | string | да | Значения: helpful, not-helpful. |
previous | string | null | нет | прежняя оценка того же оценившего; null — первая Значения: helpful, not-helpful. |
changed | boolean | да | false — та же оценка повторно: ничего не записано |
inReport | boolean | да | оценка ушла в трассу прогона и попадёт в дашборд |
reason | string | нет | почему не попала в отчёт (при inReport: false) |
400. Ошибка RFC 9457
403. Ошибка RFC 9457
404. Ошибка RFC 9457