Конечные точки классов

У всех классов объекта есть общие конечные точки.

API

POST /api/v1/<class>/<action>

Где <class> - это не абстрактный класс из дерева классов объекта.

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

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

Действие тип

POST /api/v1/<class>/type

Информация о типе объекта.

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

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

Действие метод

POST /api/v1/<class>/method

Информация о методах объекта.

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

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

Действие количество

POST /api/v1/<class>/count

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

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

Действие установить

POST /api/v1/<class>/set

Установить данные объекта.

Параметры

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

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

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

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

Действие получить

POST /api/v1/<class>/get

Получить данные объекта.

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

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

ВНИМАНИЕ: Формат данных в ответе уникален для каждого класса и подробно описан в разделе класс-таблицы.

Действие список

POST /api/v1/<class>/list

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

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