task-stages-delete.md

Удалить стадию канбана или «Моего плана» task.stages.delete

Scope: task

Кто может выполнять метод:

• любой пользователь для стадий «Моего плана»
• любой пользователь с доступом к группе для стадий канбана

Метод удаляет стадию канбана или «Моего плана».

Принимает на вход id стадии. Стадия проверяется на достаточный уровень прав, а также на то, что в ней нет задач.

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

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

#| || Название тип | Описание || || id* integer | Идентификатор стадии, которую необходимо удалить || || isAdmin boolean | Если установлено true, то проверки прав происходить не будет, при условии, что запрашивающий является администратором портала || |#

Примеры кода

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

{% list tabs %}

• cURL (Webhook)

  curl -X POST \
  -H "Content-Type: application/json" \
  -d '{
  "id": 5
  }' \
  https://your-domain.bitrix24.com/rest/_USER_ID_/_CODE_/task.stages.delete

• cURL (OAuth)

  curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: YOUR_ACCESS_TOKEN" \
  -d '{
  "id": 5
  }' \
  https://your-domain.bitrix24.com/rest/task.stages.delete

• JS

  const stageId = 5;
  BX24.callMethod(
      'task.stages.delete',
      {
          id: stageId,
      },
      function(res)
      {
          console.log(res);
      }
  );

• PHP

  require_once('crest.php'); // подключение CRest PHP SDK
  
  $stageId = 5;
  
  // выполнение запроса к REST API
  $result = CRest::call(
      'task.stages.delete',
      [
          'id' => $stageId
      ]
  );
  
  // Обработка ответа от Битрикс24
  if ($result['error']) {
      echo 'Error: '.$result['error_description'];
  } else {
      print_r($result['result']);
  }

{% endlist %}

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

HTTP-Статус: 200

{
    "result": true
}

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

#| || Название тип | Описание || || result boolean | Возвращает true в случае успешного удаления стадии || |#

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

HTTP-статус: 400

{
    "error": "CANT_DELETE_FIRST",
    "error_description": "Нельзя удалить первую стадию. Передвиньте стадию, чтобы удалить"
}

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

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

#| || Код | Описание || || ACCESS_DENIED | Вы не можете управлять стадиями|| || CANT_DELETE_FIRST | Нельзя удалить первую стадию. Передвиньте стадию, чтобы удалить || || IS_SYSTEM | Стадия, установленная по умолчанию, не может быть удалена || || NOT_FOUND | Стадия не найдена || |#

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

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

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