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
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);
}
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.bizproc.workflow.terminate(
bitrix_id="65e5a449e8f135.21284909",
status="Terminated by rest app.",
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "bizproc.workflow.terminate", b24.Params{
"ID": "65e5a449e8f135.21284909",
"STATUS": "Terminated by rest app.",
})
if err != nil {
return fmt.Errorf("bizproc.workflow.terminate: %w", err)
}
// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.Result)
Ответ
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 |

