Конечные точки документооборота

Конечные точки документооборота.

API

Сущность

POST /api/v1/entity

Получить список сущностей.

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

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

Класс

POST /api/v1/class

Получить список (дерево) классов объекта.

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

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

Действие

POST /api/v1/action

Получить список действий.

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

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

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

POST /api/v1/action/execute

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

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

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

Тип состояния

POST /api/v1/state/type

Получить список типов состояний объекта.

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

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

Состояние

POST /api/v1/state

Получить список состояний объекта.

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

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

Тип объекта

POST /api/v1/type

Получить список типов объекта.

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

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

Метод

POST /api/v1/method

Получить список методов.

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

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

Получить

POST /api/v1/method/get

Получить информацию о методах документооборота.

Обязателен как минимум один из параметров указанный в теле запроса:

Имя	Тип	Описание
object	UUID	Идентификатор объекта
class	UUID	Идентификатор класса
state	UUID	Идентификатор состояния
classcode	STRING	Код класса (вместо идентификатора)
statecode	STRING	Код состояния (вместо идентификатора)

Пример:

Запрос:

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

classcode=client&statecode=enabled

Ответ:

[
  {"id":"57913c0f-6c46-4126-b812-cbcab16ebdf8","parent":null,"entity":"328286d2-15e9-432c-bf77-b056c34bd769","entitycode":"client","entityname":"Клиент","class":"3228f3af-323f-4301-bd30-2d1c8fca18d9","classcode":"client","classlabel":"Клиент","state":"f6a3d756-c72a-44e5-b7d2-baced1592e8e","statecode":"enabled","statelabel":"Утверждён","action":"00000000-0000-4000-b003-000000000013","actioncode":"disable","actionname":"Отключить","code":"enabled:disable","label":"Закрыть","sequence":1,"visible":true},
  {"id":"36119d14-3517-4941-b18c-7ca95e1f5540","parent":null,"entity":"328286d2-15e9-432c-bf77-b056c34bd769","entitycode":"client","entityname":"Клиент","class":"3228f3af-323f-4301-bd30-2d1c8fca18d9","classcode":"client","classlabel":"Клиент","state":"f6a3d756-c72a-44e5-b7d2-baced1592e8e","statecode":"enabled","statelabel":"Утверждён","action":"00000000-0000-4000-b003-000000000012","actioncode":"delete","actionname":"Удалить","code":"enabled:delete","label":"Удалить","sequence":2,"visible":true}
]

Список

POST /api/v1/method/list

Возвращает методы в виде списка.

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

Выполнить

POST /api/v1/method/execute

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

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

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

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

Пример:

Запрос:

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

{"object": "308e1e11-1777-4fda-89de-1e103887e9a3", "code": "enable"}