arrow-left

All pages
gitbookPowered by GitBook
1 of 1

Loading...

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

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

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

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

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

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

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

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

hashtag
Общие поля

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

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

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

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

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

meta_data

Json

любые

technical_meta_data

Json

технические поля, зарезервированные для работы модулей

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

original_url

Url

HTTP-ссылка на файл на сервере API

tags

Array(String)

список для этого файла

type

String

(BIOMETRY\QUALITY\DOCUMENTS)

results_data

Json

данные результата анализа

Поле

Тип

Описание

time_created

Timestamp

время создания объекта (кроме пользователя и компании)

time_updated

Timestamp

Поле

Тип

Описание

company_id

UUID

код компании в системе

name

String

Поле

Тип

Описание

user_id

UUID

код пользователя в системе

user_type

String

Поле

Тип

Описание

folder_id

UUID

код папки в системе

resolution_status

ResolutionStatus

Поле

Тип

Описание

media_id

UUID

код медиа

original_name

String

Поле

Тип

Описание

analyse_id

UUID

код анализа

folder_id

UUID

роли
Анализ
Правилами назначения анализов
здесь

время изменения объекта

наименование компании в системе

статус последнего папки

оригинальное имя файла (в файловой системе клиента)

код папки

пользовательские поля
роль пользователя в системе
роль
роли пользователей
флаг админа
флаг сервисного пользователя
анализа
тегов
тип анализа