SvayaИИ-платформаПлатформаПримерыПродуктыВнедрение

Svaya / Документация / Программный интерфейс

Процессы и задания

Здесь собраны адреса, параметры, поля запросов и коды ответов раздела «Процессы и задания». Каждая операция описана отдельно, с таблицами полей.

Описание собрано из договора m03-processes, версия 1.3.0. Как получить токен и в каком формате приходят ошибки, написано на странице «Обзор и вход».

Список/поиск процессов (фильтры пакет/версия/маршрут/статус/субъект/период; курсор)

GET /api/core/v1/processes операция listProcesses

Параметры

ПолеТипОбязательноОписание
packageId (в запросе)stringнет
packageVersion (в запросе)stringнет
routeId (в запросе)stringнет
status (в запросе)stringнет
subject (в запросе)stringнет
cursor (в запросе)stringнет
trial (в запросе)booleanнет

Ответы

200. OK

Поля ответа

ПолеТипОбязательноОписание
itemsobject[]нет
items[].idstringнет
items[].packageIdstringнет
items[].packageVersionstringнет
items[].routeIdstringнет
items[].statusstringнетЗначения: running, waiting_gate, suspended, compensating, completed, cancelled, compensated, failed, compensation_failed.
items[].waitingstring | nullнетЗначения: step, backoff, timer, gate, event.
items[].createdAtintegerнет
items[].finishedAtinteger | nullнет
items[].failureReasonstring | nullнет
items[].queueobjectнет
items[].queue.priorityintegerда1 «Срочный», 2 «Обычный», 3 «Фоновый» Значения: 1, 2, 3.
items[].queue.requestClassstringдакласс обращений процесса к модели: «живой» или «фоновый» Значения: interactive, background.
items[].queue.waitingForstring | nullнетпочему задание ещё не исполняется (только getProcess); null — не ждёт Значения: turn, window, limit, capacity.
items[].queue.untilinteger | nullнетмс эпохи: открытие окна или момент повтора; waitingFor window при null — окна правил не пересекаются
items[].resultobject | nullнет
items[].result.outcomestringдаидентификатор узла-конца маршрута верхнего уровня (код итога)
items[].result.titlestringданазвание итога: снимок title узла-конца на момент завершения
items[].result.dataobject | nullнетполя, объявленные end.output маршрута; null — данные больше 65 536 байт (тогда dataTruncated: true)
items[].result.dataTruncatedbooleanнетданные результата не помещаются в предел 65 536 байт UTF-8 и не отдаются
items[].trialbooleanнет
items[].trialStopobject | nullнет
items[].trialStop.nodeIdstringда
items[].trialStop.connectorIdstringда
items[].trialStop.toolstringда
items[].traceIdstringнет
items[].activeNodesobject[]нетАктивные узлы: узел активен, пока у него есть незавершённая задача.
items[].activeNodes[].nodeIdstringда
items[].activeNodes[].branchstringдаветвь (branchPath); пустая строка — корень
items[].activeNodes[].kindstringдаЗначения: node, compensation, timer.
items[].activeNodes[].attemptintegerда
items[].activeNodes[].runAfterintegerдаepoch ms; в будущем — отложенный повтор
items[].activeBranchesstring[]нет
items[].journalobjectнетЖурнал целиком — `GET /processes/{id}/journal`.
items[].journal.entriesintegerда
items[].journal.lastEventstring | nullда
items[].journal.lastNodeIdstring | nullда
items[].journal.lastAtinteger | nullда
nextCursorstring | nullнет

Постановка процесса

POST /api/core/v1/processes операция createProcess

Параметры

ПолеТипОбязательноОписание
Idempotency-Key (заголовок)stringда

Поля тела запроса

ПолеТипОбязательноОписание
packageIdstringда
packageVersionstringда
routeIdstringда
inputanyда
subjectobjectда
subject.idstringда
subject.classstringдаЗначения: staff, service, public.
channelstringдаЗначения: staff, service, public.
ownershipAttrsobjectнет
trialbooleanнет
overlayVersionintegerнет
trialDecisionsobjectнет
trialCommentsobjectнет

Ответы

201. Создан

Поля ответа

ПолеТипОбязательноОписание
processIdstringнет
deduplicatedbooleanнет

403. Ошибка RFC 9457

409. Ошибка RFC 9457

422. Ошибка RFC 9457

Статус + подстатус waiting, активные узлы/ветви, ссылка на трассу

GET /api/core/v1/processes/{id} операция getProcess

Параметры

ПолеТипОбязательноОписание
id (в адресе)string (uuid)да

Ответы

200. OK

Поля ответа

ПолеТипОбязательноОписание
idstringнет
packageIdstringнет
packageVersionstringнет
routeIdstringнет
statusstringнетЗначения: running, waiting_gate, suspended, compensating, completed, cancelled, compensated, failed, compensation_failed.
waitingstring | nullнетЗначения: step, backoff, timer, gate, event.
createdAtintegerнет
finishedAtinteger | nullнет
failureReasonstring | nullнет
queueobjectнет
queue.priorityintegerда1 «Срочный», 2 «Обычный», 3 «Фоновый» Значения: 1, 2, 3.
queue.requestClassstringдакласс обращений процесса к модели: «живой» или «фоновый» Значения: interactive, background.
queue.waitingForstring | nullнетпочему задание ещё не исполняется (только getProcess); null — не ждёт Значения: turn, window, limit, capacity.
queue.untilinteger | nullнетмс эпохи: открытие окна или момент повтора; waitingFor window при null — окна правил не пересекаются
resultobject | nullнет
result.outcomestringдаидентификатор узла-конца маршрута верхнего уровня (код итога)
result.titlestringданазвание итога: снимок title узла-конца на момент завершения
result.dataobject | nullнетполя, объявленные end.output маршрута; null — данные больше 65 536 байт (тогда dataTruncated: true)
result.dataTruncatedbooleanнетданные результата не помещаются в предел 65 536 байт UTF-8 и не отдаются
trialbooleanнет
trialStopobject | nullнет
trialStop.nodeIdstringда
trialStop.connectorIdstringда
trialStop.toolstringда
traceIdstringнет
activeNodesobject[]нетАктивные узлы: узел активен, пока у него есть незавершённая задача.
activeNodes[].nodeIdstringда
activeNodes[].branchstringдаветвь (branchPath); пустая строка — корень
activeNodes[].kindstringдаЗначения: node, compensation, timer.
activeNodes[].attemptintegerда
activeNodes[].runAfterintegerдаepoch ms; в будущем — отложенный повтор
activeBranchesstring[]нет
journalobjectнетЖурнал целиком — `GET /processes/{id}/journal`.
journal.entriesintegerда
journal.lastEventstring | nullда
journal.lastNodeIdstring | nullда
journal.lastAtinteger | nullда

404. Ошибка RFC 9457

getProcessJournal

GET /api/core/v1/processes/{id}/journal операция getProcessJournal

Параметры

ПолеТипОбязательноОписание
id (в адресе)string (uuid)да
cursor (в запросе)stringнет

Ответы

200. OK

История кругов гейтов процесса (включая авто-исходы resolvedBy:auto)

GET /api/core/v1/processes/{id}/gates операция getProcessGates

Параметры

ПолеТипОбязательноОписание
id (в адресе)string (uuid)да
cursor (в запросе)stringнет

Ответы

200. OK

Ожидания узла «Ждать» процесса (блок 3) — ключи соотнесения, срок, напоминания, исход

GET /api/core/v1/processes/{id}/waits операция getProcessWaits

Параметры

ПолеТипОбязательноОписание
id (в адресе)string (uuid)да

Ответы

200. OK

404. Ошибка RFC 9457

Закрыть ожидание узла «Ждать» извне исходом из объявленных (оператор, внешняя система)

POST /api/core/v1/processes/{id}/waits/{waitId}:signal операция signalWait

Параметры

ПолеТипОбязательноОписание
id (в адресе)string (uuid)да
waitId (в адресе)string (uuid)да
Idempotency-Key (заголовок)stringда

Поля тела запроса

ПолеТипОбязательноОписание
outcomestringдаreplied | event | timeout — из объявленных ожиданием
payloadobjectнеттело события — уходит в результат узла рядом с исходом

Ответы

204. Ожидание закрыто

404. Ошибка RFC 9457

409. Ошибка RFC 9457

422. Ошибка RFC 9457

cancelProcess

POST /api/core/v1/processes/{id}:cancel операция cancelProcess

Параметры

ПолеТипОбязательноОписание
id (в адресе)string (uuid)да
Idempotency-Key (заголовок)stringда

Поля тела запроса

ПолеТипОбязательноОписание
reasonstringда

Ответы

204. Отменён

409. Ошибка RFC 9457

Оценка ответа прогона получившим его («помог / не помог»; повтор с другим значением — замена)

POST /api/core/v1/processes/{id}:rate операция rateProcessAnswer

Параметры

ПолеТипОбязательноОписание
id (в адресе)string (uuid)да
Idempotency-Key (заголовок)stringда

Поля тела запроса

ПолеТипОбязательноОписание
ratingstringдасторона двусторонней шкалы (bm.feedback.rating) Значения: helpful, not-helpful.
answerIdstringнетКакой ответ прогона оценён (прогон может выдать несколько). Пусто — ответ прогона в целом. Только у rateProcessAnswer; у карточки гейта ответ — сам гейт. Дашборд считает ПОСЛЕДНЮЮ оценку на прогон, а не на ответ: разные ответы одного прогона в CSAT не разделяются.

Ответы

200. Оценка сохранена

Поля ответа

ПолеТипОбязательноОписание
processIdstringда
answerIdstringда
ratingstringдаЗначения: helpful, not-helpful.
previousstring | nullнетпрежняя оценка того же оценившего; null — первая Значения: helpful, not-helpful.
changedbooleanдаfalse — та же оценка повторно: ничего не записано
inReportbooleanдаоценка ушла в трассу прогона и попадёт в дашборд
reasonstringнетпочему не попала в отчёт (при inReport: false)

400. Ошибка RFC 9457

403. Ошибка RFC 9457

404. Ошибка RFC 9457