API: lifecycles

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

`POST /api/v1/lifecycles/{entity_name}/processEvent`

Process Event

Открыть отдельной страницей →

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

Параметр	Где	Обязателен	Тип	Описание
`entity_name`	path	да	`string`
`Idempotency-Key`	header	нет	`string`	Optional.

Тело запроса: application/json — схема ProcessEventRequest

Поле	Тип	Обязательно	Описание
`event`	`string`	нет	outlet name on automated steps
`filter`	`object \| null`	нет
`lcid`	`integer \| null`	нет
`max`	`integer`	нет	hard upper bound per call

Пример:

{
  "event": "tick",
  "lcid": 4,
  "max": 50
}

Ответы:

Код	Смысл	Тело
`200`	Successful Response	`ProcessEventResponse`
`401`	Missing or invalid authentication credentials	`ErrorResponse`
`422`	Validation Error	`HTTPValidationError`

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

Advance

Открыть отдельной страницей →

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

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

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

Тело запроса: application/json — схема AdvanceRequest

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

Пример:

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

Ответы:

Код	Смысл	Тело
`200`	Successful Response	`AdvanceResponse`
`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`

`GET /api/v1/lifecycles/{entity_name}/{guid}/log`

Read Log

Открыть отдельной страницей →

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

Параметр	Где	Обязателен	Тип
`entity_name`	path	да	`string`
`guid`	path	да	`integer`
`limit`	query	нет	`integer`

Ответы:

Код	Смысл	Тело
`200`	Successful Response	`массив LifecycleLogRead`
`401`	Missing or invalid authentication credentials	`ErrorResponse`
`422`	Validation Error	`HTTPValidationError`

`POST /api/v1/lifecycles/{entity_name}/{guid}/postMessage`

Post Message

Открыть отдельной страницей →

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

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

Тело запроса: application/json — схема PostMessageRequest

Поле	Тип	Обязательно	Описание
`detail`	`object \| null`	нет
`message`	`string`	да

Пример:

{
  "message": "Held back: waiting for the source to confirm the figure."
}

Ответы:

Код	Смысл	Тело
`200`	Successful Response	`LifecycleLogRead`
`401`	Missing or invalid authentication credentials	`ErrorResponse`
`422`	Validation Error	`HTTPValidationError`

`GET /api/v1/lifecycles/{entity_name}/{guid}/state`

Get State

Открыть отдельной страницей →

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

Параметр	Где	Обязателен	Тип	Описание
`entity_name`	path	да	`string`
`guid`	path	да	`integer`

Ответы:

Код	Смысл	Тело
`200`	Successful Response	`LifecycleStateResponse`
`401`	Missing or invalid authentication credentials	`ErrorResponse`
`422`	Validation Error	`HTTPValidationError`

`POST /api/v1/lifecycles/{entity_name}/{guid}/stepTo`

Step To

Открыть отдельной страницей →

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

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

Тело запроса: application/json — схема StepToRequest

Поле	Тип	Обязательно	Описание
`comment`	`string \| null`	нет
`detail`	`object \| null`	нет
`to_step`	`integer`	да	target step id from LC definition

Пример:

{
  "comment": "reviewed; moving to publish-ready",
  "detail": {
    "reviewer": "agent"
  },
  "to_step": 3
}

Ответы:

Код	Смысл	Тело
`200`	Successful Response	`AdvanceResponse`
`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`