Публичное API: Получить список экземпляров процесса

Запрос

POST /pub/v1/bpm/instance/bytemplateid/{id}/list

Параметры пути (path)

Имя параметра	Тип	Описание	Дополнительно
id	uuid	Идентификатор шаблона	Обязательный

Тело запроса (body)

Тело запроса принимает ресурс Получить список экземпляров процесса - Request. Содержит следующие доступные для записи свойства:

{
    "active": "boolean",
    "filter": {
        "<key>": {}
    },
    "from": "int64",
    "ids": [
        "uuid"
    ],
    "size": "int64",
    "sortExpressions": [
        {
            "ascending": "boolean",
            "field": "string"
        }
    ]
}

Свойства

Имя	Тип	Описание	Дополнительно
active	boolean	Показывать только активные (не удаленные)	Опционально.
filter	object	Фильтрация	Опционально.
filter.<key>	map of object		Опционально.
from	int64	Возвращать начиная с элемента	Опционально.
ids[]	array of uuid	Фильтрация по идентификаторам	Опционально.
size	int64	Количество возвращаемых элементов (максимум 100)	Опционально.
sortExpressions[]	array	Правила сортировки	Опционально.
sortExpressions[].ascending	boolean	Признак сортировки по возрастанию	Опционально.
sortExpressions[].field	string	Поле сортировки	Опционально.

Авторизация

Запрос обязательно должен использовать один из следующих методов авторизации: API key

Ответ

Могут быть возвращены следующие коды состояния HTTP.

HTTP статус	Описание	Модель ответа
200	OK Модель списка экземпляров процесса.	Модель списка экземпляров процесса (Получить список экземпляров процесса)