task-stages-update.md

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

Scope: task

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

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

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

Метод также применяется для перемещения стадии с одной позиции на другую. Для этого достаточно передать нужный AFTER_ID.

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

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

#| || Название тип | Описание || || id* integer | Идентификатор стадии || || fields* array | Значения полей (подробное описание приведено ниже) для обновления стадии канбана или «Моего плана» || || isAdmin boolean | Если установлено true, то проверки прав происходить не будет. При условии, что запрашивающий является администратором портала || |#

Параметр fields

#| || Название тип | Описание || || TITLE string | Заголовок стадии || || COLOR string | Цвет стадии в формате RGB || || AFTER_ID integer | Идентификатор стадии, после которой надо добавить новую стадию.

Если не указано или равно 0, то добавится в начало || |#

При обновлении стадии группы при недостаточном уровне прав выводится ошибка доступа.

Примеры кода

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

{% list tabs %}

• cURL (Webhook)

  curl -X POST \
  -H "Content-Type: application/json" \
  -d '{
  "id": 5,
  "fields": {
      "TITLE": "Новая стадия",
      "SORT": 200,
      "COLOR": "FF5733"
  }
  }' \
  https://your-domain.bitrix24.com/rest/_USER_ID_/_CODE_/task.stages.update

• cURL (OAuth)

  curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: YOUR_ACCESS_TOKEN" \
  -d '{
  "id": 5,
  "fields": {
      "TITLE": "Новая стадия",
      "SORT": 200,
      "COLOR": "FF5733"
  }
  }' \
  https://your-domain.bitrix24.com/rest/task.stages.update

• JS

  const stageId = 5;
  const fields = {
      TITLE: "Новая стадия",
      SORT: 200,
      COLOR: "FF5733"
  };
  BX24.callMethod(
      'task.stages.update',
      {
          id: stageId,
          fields: fields
      },
      function(res)
      {
          console.log(res);
      }
  );

• PHP

  require_once('crest.php'); // подключение CRest PHP SDK
  
  $stageId = 5;
  $fields = [
      "TITLE" => "Новая стадия",
      "SORT" => 200,
      "COLOR" => "FF5733"
  ];
  
  // выполнение запроса к REST API
  $result = CRest::call(
      'task.stages.update',
      [
          'id' => $stageId,
          'fields' => $fields
      ]
  );
  
  // Обработка ответа от Битрикс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": "ACCESS_DENIED",
    "error_description": "Вы не можете изменять стадии в этой группе"
}

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

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

#| || Код | Описание || || ACCESS_DENIED | Вы не можете изменять стадии в этой группе || || NOT_FOUND | Стадия не найдена || |#

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

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

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