Связанные объекты

Объекты в системе можно связывать друг с другом. Данные хранятся с учётом истории изменений.

Для того, чтобы получить данные в прошлом необходимо перевести систему в режим работы с архивной датой.

API

Связать

POST /api/v1/object/link

Связать объекты.

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

Имя	Тип	Значение	Описание
object	UUID		Обязательный. Идентификатор объекта.
linked	UUID		Обязательный. Идентификатор связанного объекта.
key	STRING		Необязательный. Ключ связи. Если не указать будет равен идентификатору связанного объекта.
datefrom	TIMESTAMP		Необязательный. Дата и время связи.

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

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

Отвязать

POST /api/v1/object/unlink

Отвязать объекты.

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

Имя	Тип	Значение	Описание
object	UUID		Обязательный. Идентификатор объекта.
linked	UUID		Обязательный. Идентификатор связанного объекта.
key	STRING		Необязательный. Ключ связи. Если не указать будет равен идентификатору связанного объекта.
datefrom	TIMESTAMP		Необязательный. Дата и время связи.

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

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

Поле	Тип	Описание
object	UUID	Идентификатор объекта.
linked	UUID	Идентификатор связанного объекта.
key	STRING	Ключ.
datefrom	TIMESTAMP	Дата и время связи.
unlink	BOOLEAN	Результат выполнения данного метода.

Расширенное API

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

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

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

Количество

POST /api/v1/object/link/count

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

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

Установить

POST /api/v1/object/link/set

Связать или отвязать объекты.

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

Имя	Тип	Значение	Описание
object	UUID		Обязательный. Идентификатор объекта.
linked	UUID		Вариативный. Идентификатор связанного объекта.
key	STRING		Вариативный. Ключ связи. Если не указать будет равен идентификатору связанного объекта.
datefrom	TIMESTAMP		Необязательный. Дата и время связи.

ВНИМАНИЕ: Если значение ключа linked не указано или равно null, то действие считается как Отвязать (в этом случае значение ключа key не должно быть пустым), иначе как Связать.

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

ВНИМАНИЕ: Ответом на запрос будут данные действия Получить. Если значение ключа linked не указано или равно null, то ответом будет пустой JSON (в этом случае удобнее использовать метод Отвязать).

Получить

POST /api/v1/object/link/get

Получить данные связанных объектов.

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

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

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

Поле	Тип	Описание
id	UUID	Идентификатор связи.
object	UUID	Идентификатор объекта.
objectlabel	STRING	Метка объекта.
linked	UUID	Идентификатор связанного объекта.
linkedlabel	STRING	Метка связанного объекта.
key	STRING	Ключ.
validfromdate	TIMESTAMP	Дата начала периода действия связи.
validtodate	TIMESTAMP	Дата окончания периода действия связи.

Список

POST /api/v1/object/link/list

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

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