Метод останавливает процессы маршрутов, запущенных авторизованным пользователем.
URL: rest/api/docflow/doc/stop_route
Тип метода: POST
Параметры:
documentID
- UUID документа
(альтернативный); в случае передачи этого параметра будут
прерваны все маршруты в указанном документе, которые
запустил авторизованный пользователь;
procInstID
- ID процесса прерываемого
маршрута (альтернативный);
locale
- код локали (не обязателен, если
не передан - используется локаль по умолчанию).
Обязательно передавать как минимум один из альтернативных
параметров documentID
или
procInstID
. В случае их одновременной
передачи приоритет имеет procInstID
.
Метод возвращает json
со следующими полями:
errorCode
- код ошибки (0 в случае
успешного выполнения);
errorMessage
- сообщение.
Пример возвращаемого json-объекта при успешном выполнении метода:
{ "errorCode": 0, "errorMessage": "Маршрут прерван" }