Группы объекта

Объекты в системе можно группировать.

API

POST /api/v1/object/group/<action>

Где <action> (действие):

• count (Количество);
• set (Установить - Добавить или Изменить);
• get (Получить);
• list (Список);

Количество

POST /api/v1/object/group/count

Количество групп объектов с возможностью указания фильтра отбора данных.

Параметры запроса: Общие параметры запроса для списка

Установить

POST /api/v1/object/group/set

Создать или изменить группу объектов.

Параметры запроса:

Имя	Тип	Значение	Описание
id	UUID		Обязательный для действия Изменить. Идентификатор группы.
code	STRING		Рекомендуемый. Код.
name	STRING		Обязательный. Наименование.
description	STRING		Необязательный. Описание.

ВНИМАНИЕ: Если значение ключа id не указано или равно null, то действие считается как Добавить, иначе как Изменить.

ВНИМАНИЕ: Значения не указанных ключей считаются как null.

ВНИМАНИЕ: Для действия Изменить не нужно передавать значения всех ключей, достаточно передать только те, которые требуется поменять.

ВНИМАНИЕ: Ответом на запрос будут данные действия Получить.

Получить

POST /api/v1/object/group/get

Получить данные группы.

Параметры запроса:

Имя	Тип	Значение	Описание
id	UUID		Вариативный. Идентификатор группы (имеет приоритет над кодом группы).
code	STRING		Вариативный. Код группы.
fields	JSON array		Необязательный. Массив JSON string полей в таблице, если не указано то запрос вернет все поля.

Формат ответа:

Поле	Тип	Описание
id	UUID	Идентификатор группы.
owner	UUID	Идентификатор учётной записи (владельца группы).
code	STRING	Код.
name	STRING	Наименование.
description	STRING	Описание.

Список

POST /api/v1/object/group/list

Получить данные по группам объектов в виде списка с возможностью указания фильтра отбора.

Параметры запроса: Общие параметры запроса для списка

Участники группы объекта

POST /api/v1/object/group/member/<action>

Где <action> (действие):

• add (Добавить);
• delete (Удалить);

Участники

POST /api/v1/object/group/member

Получить список объектов-участников группы.

Параметры запроса:

Имя	Тип	Значение	Описание
id	UUID		Вариативный. Идентификатор группы (имеет приоритет над кодом группы).
code	STRING		Вариативный. Код группы.

Формат ответа:

Объект

Добавить

POST /api/v1/object/group/member/add

Добавить объект в группу.

Параметры запроса:

Имя	Тип	Значение	Описание
id	UUID		Вариативный. Идентификатор группы (имеет приоритет над кодом группы).
code	STRING		Вариативный. Код группы.
object	UUID		Обязательный. Идентификатор объекта.

Удалить

POST /api/v1/object/group/member/delete

Удалить объект из группы.

Параметры запроса:

Имя	Тип	Значение	Описание
id	UUID		Вариативный. Идентификатор группы (имеет приоритет над кодом группы).
code	STRING		Вариативный. Код группы.
object	UUID		Обязательный. Идентификатор объекта.

ВНИМАНИЕ: Если из группы будут удалены все объекты сама группа будет удалена автоматически.