Данные объекта

С объектом в системе можно связать данные в произвольном формате.

API

POST /api/v1/object/data

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

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

Имя	Тип	Значение	Описание
id	NUMERIC		Обязательный. Идентификатор объекта.
data	JSON array	null OR json	Вариативный. Массив JSON объектов с произвольными данными.

Формат data:

Имя	Тип	Значение	Описание
type	STRING	text, json, xml	Обязательный. Код типа произвольных данных объекта.
code	STRING		Обязательный. Код произвольных данных.
data	STRING		Вариативный. Произвольные данные.

ВНИМАНИЕ: Если значение data не указано или равно null, то метод работает как Получить иначе как Установить.

Установить

POST /api/v1/object/data/set

Установить произвольные данные для объекта.

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

Имя	Тип	Значение	Описание
id	NUMERIC		Обязательный. Идентификатор объекта.
data	JSON array		Обязательный. Массив JSON объектов с произвольными данными.

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

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

Пример:

Запрос (установить):

POST /api/v1/object/data/set HTTP/1.1
Host: localhost:8080
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.[сокращенно для краткости].NorYsi-Ht826HUFCEArVZ60_dEUmYiJYXubnTyweIMg

{"id": 2, "data": [{"type": "json", "code": "unique.code", "data": "{\"search\": [{\"field\": \"validfromdate\", \"value\": \"24.03.2020 00:31:23\", \"compare\": \"LEQ\"}, {\"field\": \"validtodate\", \"value\": \"24.03.2020 00:31:23\", \"compare\": \"GTR\"}]}"}]}

Запрос (удалить):

POST /api/v1/object/data/set HTTP/1.1
Host: localhost:8080
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.[сокращенно для краткости].NorYsi-Ht826HUFCEArVZ60_dEUmYiJYXubnTyweIMg

{"id": 2, "data": [{"type": "json", "code": "unique.code", "data": null}]}

Получить

POST /api/v1/object/data/get

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

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

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

Пример:

Запрос:

POST /api/v1/object/data/get HTTP/1.1
Host: localhost:8080
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.[сокращенно для краткости].NorYsi-Ht826HUFCEArVZ60_dEUmYiJYXubnTyweIMg

{"id": 2, "typecode": "json", "code": "unique.code"}

Список

POST /api/v1/object/data/list

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

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

Запрос:

POST /api/v1/object/data/list HTTP/1.1
Host: localhost:8080
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.[сокращенно для краткости].NorYsi-Ht826HUFCEArVZ60_dEUmYiJYXubnTyweIMg

{"filter": {"object": 2, "typecode": "json", "code": "unique.code"}}