---
title: API: entities
description: REST-эндпоинты с тегом entities — сгенерировано из OpenAPI-контракта платформы (12 операций).
locale: ru
version: 0.2.0
canonical: https://enterium-developer-docs.pages.dev/developers/ru/api/entities/
---

> Documentation index: https://enterium-developer-docs.pages.dev/developers/llms.txt — every page of this portal has a Markdown twin at <route>.md; the frozen API contract is at https://enterium-developer-docs.pages.dev/developers/api/openapi.json.

:::note
Сгенерировано из OpenAPI-контракта — не редактировать руками. Сводки операций и описания полей приводятся на английском (дословно из контракта). Интерактивный обозреватель с полными схемами: [https://entherium.duckdns.org:8443/reference](https://entherium.duckdns.org:8443/reference); замороженная спецификация этой сборки: [openapi.json](/developers/api/openapi.json).
:::

## `GET /api/v1/entities`

List Entity Types

[Открыть отдельной страницей →](./get-entities/)

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

**Ответы:**

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

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

List Records

[Открыть отдельной страницей →](./get-entities-name/)

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

[Открыть отдельной страницей →](./post-entities-name/)

**Авторизация:** нужен `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

[Открыть отдельной страницей →](./post-entities-name-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` | да |  |

_Пример:_

```json
{
  "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

[Открыть отдельной страницей →](./post-entities-name-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

[Открыть отдельной страницей →](./get-entities-name-count/)

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-entities-name-guid/)

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

[Открыть отдельной страницей →](./get-entities-name-guid/)

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

[Открыть отдельной страницей →](./patch-entities-name-guid/)

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

[Открыть отдельной страницей →](./get-entities-name-guid-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

[Открыть отдельной страницей →](./get-entities-name-guid-field-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

[Открыть отдельной страницей →](./post-entities-name-guid-restore/)

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` |