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

Scope: bizproc

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

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

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

ID*
string

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

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

STATUS
string

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

Примеры кода

Как использовать примеры в документации

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

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

try
        {
        	const response = await $b24.callMethod(
        		'bizproc.workflow.terminate',
        		{
        			ID: '65e5a449e8f135.21284909',
        			STATUS: 'Terminated by rest app.',
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log('response', result.answer);
        	if(result.error())
        		alert("Error: " + result.error());
        	else
        		console.log(result);
        }
        catch( error )
        {
        	console.error('Error:', error);
        }

try {
            $workflowId = 'your_workflow_id'; // Replace with actual workflow ID
            $message = 'Workflow terminated'; // Replace with actual message
            $result = $serviceBuilder
                ->getBizProcScope()
                ->workflow()
                ->terminate($workflowId, $message);
            if ($result->isSuccess()) {
                print($result->getCoreResponse()->getResponseData()->getResult()[0]);
            } else {
                print('Termination failed.');
            }
        } catch (Throwable $e) {
            print('Error: ' . $e->getMessage());
        }

BX24.callMethod(
            'bizproc.workflow.terminate',
            {
                ID: '65e5a449e8f135.21284909',
                STATUS: 'Terminated by rest app.',
            },
            function(result) {
                console.log('response', result.answer);
                if(result.error())
                    alert("Error: " + result.error());
                else
                    console.log(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'bizproc.workflow.terminate',
            [
                'ID' => '65e5a449e8f135.21284909',
                'STATUS' => 'Terminated by rest app.'
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Обработка ответа

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, 403

{
            "error": "ACCESS_DENIED",
            "error_description": "Access denied!",
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Статус	Код	Описание	Значение
`403`	`ACCESS_DENIED`	Access denied!	Метод запустил не администратор
`400`	`ERROR_WRONG_WORKFLOW_ID`	Empty workflow instance ID	Передали пустое значение в параметр `ID`

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Получить список бизнес-процессов

Удалить активный процесс

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

Параметры методаПараметры метода

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

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

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

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение