Массовое обновление экземпляров процессов
Массовое обновление экземпляров процессов позволяет обновить экземпляры указанного процесса,
которые находятся в статусе В ожидании, на последнюю опубликованную версию.
Обновлять можно как отдельные экземпляры процессов, так и все активные экземпляры по указанному шаблону.
Способы массового обновления экземпляров процессов:
Обновление указанных экземпляров процессов
- В теле запроса указать список идентификаторов обновляемых экземпляров процессовinstanceIds
Пример тела запроса для обновления указанных экземпляров процессов:{ "instances":["131141f6-0d89-4316-a8f1-bc816f0672ef"] }Обновление всех активных экземпляров процессов по шаблону:
- В теле запроса указать параметр"updateAllActive":true
- Опционально. Указать в параметреunselectedIdsсписок идентификаторв экземпляров процессов, которые не нужно обновлять.
Пример тела запроса для обновления всех активных экземпляров процессов, за исключением указанных:{ "updateAllActive":true, "unselectedIds":["131141f6-0d89-4316-a8f1-bc816f0672ef"] }
Запрос
POST /pub/v1/bpm/instance/bytemplate/{namespace}/{code}/version
Параметры пути (path)
| Имя параметра | Тип | Описание | Дополнительно |
|---|---|---|---|
| namespace | string | Код раздела |
Обязательный |
| code | string | Код процесса |
Обязательный |
Тело запроса (body)
Тело запроса принимает ресурс Массовое обновление экземпляров процессов — Request. Содержит следующие доступные для записи свойства:
{
"instanceIds": [
"uuid"
],
"unselectedIds": [
"uuid"
],
"updateAllActive": "boolean"
}
Свойства
| Имя | Тип | Описание | Дополнительно |
|---|---|---|---|
| instanceIds[] | array of uuid |
Список идентификаторов обновляемые экземпляров процессов |
Опциональное |
| unselectedIds[] | array of uuid |
Список идентификаторов экземпляров процессов, которые не нужно обновлять |
Опциональное |
| updateAllActive | boolean |
Обновить все активные экземпляры процесса по указанному шаблону |
Опциональное |
Авторизация
Запрос обязательно должен использовать один из следующих методов авторизации:
API key
Ответ
Могут быть возвращены следующие коды состояния HTTP:
| HTTP-статус | Описание | Модель ответа |
|---|---|---|
| 200 | OK Модель массового обновления экземпляров процессов |
Модель массового обновления экземпляров процессов (Массовое обновление экземпляров процессов) |
| 400 | Bad Request Неверные параметры запроса |
|
| 403 | Forbidden Массовое обновление экземпляров процессов может выполнять только администратор |
|
| 404 | Not Found Процесс не найден |