Конечные точки объекта

Конечные точки объекта.

API

POST /api/v1/object/<action>

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

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

Количество

POST /api/v1/object/count

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

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

Установить

POST /api/v1/object/set

Создать или изменить объект.

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

Имя	Тип	Значение	Описание
id	NUMERIC		Обязательный для действия Изменить. Идентификатор объекта.
parent	NUMERIC		Необязательный. Идентификатор объекта родителя.
type	STRING		Рекомендуемый. Код типа объекта.
label	STRING		Рекомендуемый. Метка объекта.
data	STRING		Необязательный. Данные объекта.

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

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

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

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

Получить

POST /api/v1/object/get

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

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

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

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

Поле	Тип	Описание
id	NUMERIC	Идентификатор объекта.
parent	NUMERIC	Идентификатор родителя объекта.
entity	NUMERIC	Идентификатор сущности.
entitycode	STRING	Код сущности.
class	NUMERIC	Идентификатор класса.
classcode	STRING	Код класса.
classlabel	STRING	Метка класса.
type	NUMERIC	Идентификатор типа.
typecode	STRING	Код типа.
typename	STRING	Наименование типа.
typedescription	STRING	Описание типа.
label	STRING	Метка.
data	STRING	Данные.
statetype	NUMERIC	Тип состояния.
statetypecode	STRING	Код типа состояния.
statetypename	STRING	Наименование типа состояния.
state	NUMERIC	Состояние.
statecode	STRING	Код состояния.
statelabel	STRING	Метка состояния.
lastupdate	TIMESTAMP	Дата последнего изменения.
owner	NUMERIC	Идентификатор учётной записи владельца.
ownercode	STRING	Код (логин) учётной записи владельца.
ownername	STRING	Наименование учётной записи владельца.
created	TIMESTAMP	Физическая дата (дата создания).
oper	NUMERIC	Идентификатор учётной записи оператора.
opercode	STRING	Код (логин) учётной записи оператора.
opername	STRING	Наименование учётной записи оператора.
operdate	TIMESTAMP	Логическая дата (дата операции).

Список

POST /api/v1/object/list

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

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

Класс объекта

POST /api/v1/object/class

Возвращает класс объекта.

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

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

Тип объекта

POST /api/v1/object/type

Возвращает тип объекта.

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

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

Состояние объекта

POST /api/v1/object/state

Возвращает состояние объекта.

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

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

Методы объекта

POST /api/v1/object/method

Возвращает методы объекта.

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

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

Выполнить метод

POST /api/v1/object/method/execute

Выполняет динамический метод объекта.

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

Имя	Тип	Значение	Описание
id	NUMERIC		Обязательный. Идентификатор объекта.
method	NUMERIC		Вариативный. Идентификатор метода имеет приоритет над code.
code	STRING		Вариативный. Код действия. Можно указать вместо идентификатора метода.
params	JSON		Необязательный. Параметры HTML формы в формате JSON.

• Обратите внимание, что в code передается не код метода, а код действия.

Выполнить действие

POST /api/v1/object/action/execute

Выполняет действие над объектом.

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

Имя	Тип	Значение	Описание
id	NUMERIC		Обязательный. Идентификатор объекта.
action	NUMERIC		Вариативный. Идентификатор метода имеет приоритет над code.
code	STRING		Вариативный. Код действия. Можно указать вместо идентификатора метода.
params	JSON		Необязательный. Параметры HTML формы в формате JSON.

Удалить объект

POST /api/v1/object/delete/force

Принудительно "удаляет" документ (минуя события документооборота).

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

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