метод REST scope: bizproc

bizproc.workflow.terminate

Остановить активный бизнес-процесс

Кто может выполнять: администратор

Описание

Метод останавливает указанный бизнес-процесс. Все данные бизнес-процесса при этом сохранятся.

Параметры

ID string обязательный

Идентификатор бизнес-процесса, который нужно остановить.

Идентификатор можно получить методом bizproc.workflow.instances

STATUS string необязательный

Установить текст статуса

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ID":"65e5a449e8f135.21284909","STATUS":"Terminated by rest app."}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/bizproc.workflow.terminate

Ответ

HTTP-статус: 200

{
    "result": true,
    "time": {
        "start": 1726476060.581428,
        "finish": 1726476060.813776,
        "duration": 0.23234796524047852,
        "processing": 0.002630949020385742,
        "date_start": "2024-09-16T08:41:00+00:00",
        "date_finish": "2024-09-16T08:41:00+00:00",
        "operating_reset_at": 1726476660,
        "operating": 0,
    },
}

Возвращаемые данные

result boolean

Корневой элемент ответа.

Содержит true в случае успеха

time time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
    "error": "ACCESS_DENIED",
    "error_description": "Access denied!",
}
Код Описание Значение
403 ACCESS_DENIED Access denied!
400 ERROR_WRONG_WORKFLOW_ID Empty workflow instance ID

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.