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

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

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

1. На верхнем уровне находится Компания. Это значит, что один экземпляр установки Oz API может обслуживать пользователей нескольких не зависящих друг от друга компаний.

2. Пользователь является инициатором любого запроса. В зависимости от роли пользователя могут присутствовать определенные ограничения на те или иные действия.

3. При выполнении Пользователем запроса на Анализ система автоматически создает Папку, помещает туда все отправленные пользователем Медиафайлы, а затем запускает собственно Анализ (один или несколько). Анализы применяются к медиафайлам из папки в соответствии с Правилами назначения анализов. Требования к медиафайлам перечислены здесь.

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

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

Общие поля

Поле	Тип	Описание
time_created	Timestamp	время создания объекта (кроме пользователя и компании)
time_updated	Timestamp	время изменения объекта
meta_data	Json	любые пользовательские поля
technical_meta_data	Json	технические поля, зарезервированные для работы модулей

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

Поле	Тип	Описание
company_id	UUID	код компании в системе
name	String	наименование компании в системе

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

Поле	Тип	Описание
user_id	UUID	код пользователя в системе
user_type	String	роль пользователя в системе
first_name	String	имя
last_name	String	фамилия
middle_name	String	отчество
email	String	email, который является логином пользователя
password	String	пароль, указывается при добавлении нового пользователя или при изменении пароля. Если роль пользователя не admin, необходимо указать поле password_old
can_start_analyze_*	String	см. роли пользователей
company_id	UUID	код компании пользователя
is_admin	Boolean	флаг админа
is_service	Boolean	флаг сервисного пользователя

Объект Папка

Поле	Тип	Описание
folder_id	UUID	код папки в системе
resolution_status	ResolutionStatus	статус последнего анализа папки

Объект Медиа

Поле	Тип	Описание
media_id	UUID	код медиа
original_name	String	оригинальное имя файла (в файловой системе клиента)
original_url	Url	HTTP-ссылка на файл на сервере API
tags	Array(String)	список тегов для этого файла

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

Поле	Тип	Описание
analyse_id	UUID	код анализа
folder_id	UUID	код папки
type	String	тип анализа (BIOMETRY\QUALITY\DOCUMENTS)
results_data	Json	данные результата анализа