bizproc-workflow-kill.md

Удалить запущенный процесс bizproc.workflow.kill

Scope: bizproc

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

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

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

{% include Сноска об обязательных параметрах %}

#| || Название тип | Описание || || ID* integer | Идентификатор бизнес-процесса || |#

Примеры кода

{% include Сноска о примерах %}

{% list tabs %}

• cURL (Webhook)

  curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"ID":"65e5a449e8f135.21284909"}' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webbhook_here**/bizproc.workflow.kill

• cURL (OAuth)

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

• JS

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

• PHP

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

• PHP (B24PhpSdk)

  try {
      $workflowId = 'your_workflow_id'; // Replace with your actual workflow ID
      $result = $serviceBuilder->getBizProcScope()
          ->workflow()
          ->kill($workflowId);
      if ($result->isSuccess()) {
          print_r($result->getCoreResponse()->getResponseData()->getResult());
      } else {
          print('Failed to kill workflow: ' . json_encode($result->getCoreResponse()->getResponseData()->getResult()));
      }
  } catch (Throwable $e) {
      print('Error occurred: ' . $e->getMessage());
  }

{% endlist %}

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

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!",
}

{% include notitle обработка ошибок %}

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

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

{% include системные ошибки %}

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

• {#T}
• {#T}
• {#T}
• {#T}