API: entities

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

`GET /api/v1/entities`

List Entity Types

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

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

Ответы:

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

`GET /api/v1/entities/{name}`

List Records

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

List entity records — paginated, sortable, filterable.

Any query param that is not a control param (limit/offset/sort/ include_meta) is read as a column filter: col (equals), col_like (ILIKE), col_from/col_to (range). Large JSON/text columns are truncated to a preview stub; ?include_meta=true adds the runtime schema.

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

Параметр	Где	Обязателен	Тип
`name`	path	да	`string`
`limit`	query	нет	`integer`
`offset`	query	нет	`integer`
`sort`	query	нет	`string \| null`
`include_meta`	query	нет	`boolean`
`include_deleted`	query	нет	`boolean`

Ответы:

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

`POST /api/v1/entities/{name}`

Create Record

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

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

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

Тело запроса: application/json

Ответы:

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

`POST /api/v1/entities/{name}/bulk-delete`

Bulk Delete

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

Delete many rows — PROD rows without approval are blocked.

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

Параметр	Где	Обязателен	Тип	Описание
`name`	path	да	`string`
`x-prod-approval`	header	нет	`string \| null`	Production guard.
`Idempotency-Key`	header	нет	`string`	Optional.

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

Поле	Тип	Обязательно	Описание
`guids`	`массив integer`	да

Пример:

{
  "guids": [
    31567,
    31568
  ]
}

Ответы:

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

`POST /api/v1/entities/{name}/bulk-export`

Bulk Export

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

Export selected rows as a downloadable JSON file.

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

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

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

Поле	Тип	Обязательно	Описание
`format`	`string`	нет
`guids`	`массив integer`	да

Ответы:

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

`GET /api/v1/entities/{name}/count`

Count Records

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

Row count for an entity, cached in-process for 30s.

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

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

Ответы:

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

`DELETE /api/v1/entities/{name}/{guid}`

Delete Record

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

Delete a row — soft (deleted_at) for soft-deletable entities.

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

Параметр	Где	Обязателен	Тип	Описание
`name`	path	да	`string`
`guid`	path	да	`integer`
`x-prod-approval`	header	нет	`string \| null`	Production guard.
`Idempotency-Key`	header	нет	`string`	Optional.

Ответы:

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

`GET /api/v1/entities/{name}/{guid}`

Read Record

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

Read one full row + runtime schema for the row drawer.

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

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

Ответы:

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

`PATCH /api/v1/entities/{name}/{guid}`

Update Record

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

Partial update — PROD-guarded and audit-logged.

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

Параметр	Где	Обязателен	Тип	Описание
`name`	path	да	`string`
`guid`	path	да	`integer`
`x-prod-approval`	header	нет	`string \| null`	Production guard.
`Idempotency-Key`	header	нет	`string`	Optional.

Тело запроса: application/json

Ответы:

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

`GET /api/v1/entities/{name}/{guid}/audit`

Read Audit

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

Audit trail for one row, projected from lifecycle_log.

Latest first. A multi-field edit is expanded into one event per field.

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

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

Ответы:

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

`GET /api/v1/entities/{name}/{guid}/field/{field}`

Read Field

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

Read one field’s full, untruncated value — lazy JSON load.

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

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

Ответы:

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

`POST /api/v1/entities/{name}/{guid}/restore`

Restore Record

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

Restore a soft-deleted row — clears deleted_at a).

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

Параметр	Где	Обязателен	Тип	Описание
`name`	path	да	`string`
`guid`	path	да	`integer`
`x-prod-approval`	header	нет	`string \| null`	Production guard.
`Idempotency-Key`	header	нет	`string`	Optional.

Ответы:

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