> For the complete documentation index, see [llms.txt](https://doc.ozforensics.com/oz-knowledge-ru/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.ozforensics.com/oz-knowledge-ru/rukovodstva/rukovodstvo-razrabotchika/api/oz-api/obekty-sistemy.md).

# Объекты системы

## Иерархия объектов

<figure><img src="https://2041336905-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHLoHbtSPFA1Ul7oKM5SC%2Fuploads%2FPm72Hkh6GCxSXmzI8V1K%2Fsystem%20objects%20ru.drawio.png?alt=media&amp;token=9447e0b1-3a39-4e05-b2b1-0d2c875de728" alt=""><figcaption></figcaption></figure>

Объекты системы имеют иерархическую структуру подчинения.&#x20;

1. На верхнем уровне находится **Компания**. Это значит, что один экземпляр установки Oz API может обслуживать пользователей нескольких не зависящих друг от друга компаний.
2. **Пользователь** является инициатором любого запроса. В зависимости от [роли](/oz-knowledge-ru/rukovodstva/rukovodstvo-razrabotchika/api/oz-api/user-roles.md) пользователя могут присутствовать определенные ограничения на те или иные действия.
3. При выполнении **Пользователем** запроса на Анализ система автоматически создает **Папку**, помещает туда все отправленные пользователем **Медиафайлы**, а затем запускает собственно [**Анализ**](/oz-knowledge-ru/rukovodstva/rukovodstvo-razrabotchika/api/oz-api/types-of-analyzes.md) (один или несколько). Анализы применяются к медиафайлам из папки в соответствии с [Правилами назначения анализов](/oz-knowledge-ru/rukovodstva/rukovodstvo-razrabotchika/api/oz-api/pravila-naznacheniya-analizov.md). Требования к медиафайлам перечислены [здесь](/oz-knowledge-ru/other/media-requirements.md).

## Поля объектов

Каждый объект имеет набор полей для работы и идентификации на уровне REST API запросов.

### Общие поля

| **Поле**              | **Тип**   | **Описание**                                                                                                 |
| --------------------- | --------- | ------------------------------------------------------------------------------------------------------------ |
| time\_created         | Timestamp | время создания объекта (кроме пользователя и компании)                                                       |
| time\_updated         | Timestamp | время изменения объекта                                                                                      |
| meta\_data            | Json      | любые [пользовательские поля](/oz-knowledge-ru/rukovodstva/rukovodstvo-razrabotchika/api/oz-api/metadata.md) |
| `technical_meta_data` | Json      | технические поля, зарезервированные для работы модулей                                                       |

### Объект Компания

| **Поле**    | **Тип** | **Описание**                    |
| ----------- | ------- | ------------------------------- |
| company\_id | UUID    | код компании в системе          |
| name        | String  | наименование компании в системе |

### Объект Пользователь

| **Поле**              | **Тип** | **Описание**                                                                                                                                                                                                                                  |
| --------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| user\_id              | UUID    | код пользователя в системе                                                                                                                                                                                                                    |
| user\_type            | String  | [роль пользователя в системе](/oz-knowledge-ru/rukovodstva/rukovodstvo-razrabotchika/api/oz-api/user-roles.md)                                                                                                                                |
| first\_name           | String  | имя                                                                                                                                                                                                                                           |
| last\_name            | String  | фамилия                                                                                                                                                                                                                                       |
| middle\_name          | String  | отчество                                                                                                                                                                                                                                      |
| email                 | String  | email, который является логином пользователя                                                                                                                                                                                                  |
| password              | String  | пароль, указывается при добавлении нового пользователя или при изменении пароля. Если [роль](/oz-knowledge-ru/rukovodstva/rukovodstvo-razrabotchika/api/oz-api/user-roles.md) пользователя не `admin`, необходимо указать поле `password_old` |
| `can_start_analyze_*` | String  | см. [роли пользователей](/oz-knowledge-ru/rukovodstva/rukovodstvo-razrabotchika/api/oz-api/user-roles.md)                                                                                                                                     |
| company\_id           | UUID    | код компании пользователя                                                                                                                                                                                                                     |
| is\_admin             | Boolean | [флаг админа](/oz-knowledge-ru/rukovodstva/rukovodstvo-razrabotchika/api/oz-api/user-roles.md)                                                                                                                                                |
| is\_service           | Boolean | [флаг сервисного пользователя](/oz-knowledge-ru/rukovodstva/rukovodstvo-razrabotchika/api/oz-api/user-roles.md)                                                                                                                               |

### Объект Папка

| **Поле**           | **Тип**          | **Описание**                                                                                                              |
| ------------------ | ---------------- | ------------------------------------------------------------------------------------------------------------------------- |
| folder\_id         | UUID             | код папки в системе                                                                                                       |
| resolution\_status | ResolutionStatus | статус последнего [анализа](/oz-knowledge-ru/rukovodstva/rukovodstvo-razrabotchika/api/oz-api/types-of-analyzes.md) папки |

### Объект Медиа

| **Поле**       | **Тип**       | **Описание**                                                                                                    |
| -------------- | ------------- | --------------------------------------------------------------------------------------------------------------- |
| media\_id      | UUID          | код медиа                                                                                                       |
| original\_name | String        | оригинальное имя файла (в файловой системе клиента)                                                             |
| original\_url  | Url           | HTTP-ссылка на файл на сервере API                                                                              |
| tags           | Array(String) | список [тегов](/oz-knowledge-ru/rukovodstva/rukovodstvo-razrabotchika/api/oz-api/media-tags.md) для этого файла |

### Объект Анализ

| **Поле**      | **Тип** | **Описание**                                                                                                                       |
| ------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| analyse\_id   | UUID    | код анализа                                                                                                                        |
| folder\_id    | UUID    | код папки                                                                                                                          |
| type          | String  | [тип анализа](/oz-knowledge-ru/rukovodstva/rukovodstvo-razrabotchika/api/oz-api/types-of-analyzes.md) (BIOMETRY\QUALITY\DOCUMENTS) |
| results\_data | Json    | данные результата анализа                                                                                                          |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://doc.ozforensics.com/oz-knowledge-ru/rukovodstva/rukovodstvo-razrabotchika/api/oz-api/obekty-sistemy.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.