Стадии

Scope: rpa Права на выполнение: для всех

Подробнее о стадиях можно прочитать в документации по модулю rpa.

rpa.stage.*

Метод	Описание	С версии
`rpa.stage.get({id: number})`	Отдает информацию о стадии по её ID. Параметр: `id` - ID стадии Ответ: { "id": 1, "name": "Запуск", "code": "", "color": "22B9FF", "sort": 1000, "semantic": null, "typeId": 1, "isFirst": true, "isSuccess": false, "isFail": false, "tasks": [ { "title": "Задание", "robotType": "RpaApproveActivity", "robotName": "A43555_78925_98855_46118", "canAppendResponsibles": true, "users": [ { "id": "U1", "entityId": 1, "name": "Anton", "photoSrc": "", "url": "\\/company\\/personal\\/user\\/1\\/", "entityType": "users" }, { "id": "U4", "entityId": 4, "name": "Piter", "photoSrc": "", "url": "\\/company\\/personal\\/user\\/4\\/", "entityType": "users" } ] } ], "robotsCount": 0, "possibleNextStages": [1,2,3,4,5], "permissions": { "droppable": true, "canMoveFrom": true } } `name` - название стадии `code` - символьный код. Можно использовать как внешний идентификатор `color` - HEX-код цвета стадии, 6 символов `sort` - индекс сортировки `semantic` - код семантики стадии. Может быть либо `SUCCESS`, либо `FAIL` `typeId` - идентификатор процесса `isFirst` - вычисляемое поле. `true`, если это первая стадия процесса `isSuccess` - вычисляемое поле. `true`, если эта стадия является успешной `isFail` - вычисляемое поле. `true`, если эта стадия является провальной `tasks` - массив заданий стадии. Каждая запись состоит имеет следующую структуру: `title` - заголовок задания `robotType` - тип задания. Может принимать одно из значений: `RpaApproveActivity` - утвердить или отклонить `RpaMoveActivity` - просто передвинуть `RpaRequestActivity` - запрос информации `RpaReviewActivity` - ознакомиться с информацией `robotName` - имя активити `users` - массив участников задания (для отрисовки в канбане на стадии) `robotsCount` - вычисляемое поле. Количество роботов на стадии `possibleNextStages` - массив идентификаторов стадий, в которые можно перенести элемент. Не используется `permissions` - набор разрешений (для канбана). `droppable` - в эту стадию могут быть перемещены элементы `canMoveFrom` - из этой стадии могут быть перемещены элементы
`rpa.stage.listForType({typeId: number, offset: ?number})`	Метод вернет список стадий процесса, отсотированный в порядке сортировки, с финальными стадиями в конце. Параметры: `typeId` - идентификатор процесса. Обязательное. `start` - сдвиг для постраничной навигации В информации о каждой стадии будут только основные данные, без `tasks`, `robotsCount`, `possibleNextStages`, `permissions` { "stages": [ { "id": 1, "name": "Запуск", "code": "", "color": "22B9FF", "sort": 1000, "semantic": null, "typeId": 1, "isFirst": true, "isSuccess": false, "isFail": false, } ] }
`rpa.stage.add({fields: {}})`	Метод создаст новую стадию и вернет в ответе данные, аналогичные ответу на запрос `rpa.stage.get`. Параметры: `fields` - список с полями стадии `fields[name]` - название стадии (обязательное) `fields[typeId]` - идентификатор процесса (обязательное) `fields[code]` - символьный код `fields[color]` - цвет стадии в виде HEX (6 символов) `fields[sort]` - идентификатор сортировки `fields[semantic]` - код семантики стадии. Может быть либо `SUCCESS`, либо `FAIL` У процесса может быть только одна успешная стадия
`rpa.stage.update({id: number, fields: {}})`	Метод обновит стадию с `id` и вернет в ответе данные, аналогичные ответу на запрос `rpa.stage.get`. Параметры: `id` - идентификатор стадии `fields` - список с полями стадии. Полностью аналогичен набору из метода `rpa.stage.add`, но без `typeId` У процесса всегда должна быть одна успешная стадия. Изменить семантику успешной стадии нельзя
`rpa.stage.delete({id: number})`	Метод удаляет стадию. Параметры: `id` - идентификатор стадии У процесса всегда должна быть одна успешная стадия. Удалить успешную стадию нельзя

Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

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

0 Вася Васильев 15.07.2022 15:33:20 Сообщение не промодерировано, возможны ошибки и неточности.
Пример изменения стадии через хук хттп://domain.com/rest/**/api-key**/rpa.item.update.json?typeId=6&id=24&&fields[stageId]=8

0 Вася Васильев 15.07.2022 15:32:22 Сообщение не промодерировано, возможны ошибки и неточности.
Пример изменения стадии через хук http://domain.com/rest/**/api-key**/rpa.item.update.json?typeId=6&id=24&&a...