POST /api/v1/lifecycles/{entity_name}/{guid}/advance

Статус: GA Доступ: по токену контракт API: 0.3.0 · capability 2026-09-03.1 Открыть как Markdown Открыть в Claude Открыть в ChatGPT

Advance

Advance a record via an outlet (analog of Entherium’s advance_record).

Авторизация: нужен Authorization: Bearer <token>

Запрос

curl -sS -X POST "https://entherium.duckdns.org:8443/api/v1/lifecycles/<entity_name>/<guid>/advance" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"detail":{"note":"verified live"},"outlet":"ok"}'

Ответ `200`

В контракте нет примера для этого ответа; схема: AdvanceResponse. Поля — в интерактивном обозревателе.

Возвращает

AdvanceResponse — Successful Response

Поле	Тип	Описание
`detail`	`object \| null` (opt.)
`entity`	`string`
`from_step`	`integer \| null`
`guid`	`integer`
`outlet`	`string`
`to_step`	`integer`

Параметры

Параметр	Где	Обязателен	Тип	По умолчанию	Ограничения	Описание
`entity_name`	path	да	`string`	—	—
`guid`	path	да	`integer`	—	—
`Idempotency-Key`	header	нет	`string`	—	uuid	Optional.

Тело запроса

Поле	Тип	Обязательно	Описание
`detail`	`object \| null`	нет
`outlet`	`string`	да	Outlet name (ok, error, or conditional name)

Пример:

{
  "detail": {
    "note": "verified live"
  },
  "outlet": "ok"
}

Ошибки

Код	Смысл	Тело
`401`	Missing or invalid authentication credentials	`ErrorResponse`
`404`	Entity or lifecycle not found	`ErrorResponse`
`409`	Transition not allowed from the current step	`ErrorResponse`
`422`	Validation Error	`HTTPValidationError`

Тело любой ошибки — {detail, code?, request_id, doc_url}: request_id — что цитировать, doc_url ведёт в Справочник ошибок.