task-stages-get.md

Получить список стадий канбана или «Моего плана» task.stages.get

Scope: task

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

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

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

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

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

#| || Название тип | Описание || || entityId* integer | Идентификатор объекта.

Возможные значения:

• ID группы — метод получит стадии канбана группы. При недостаточном уровне прав выводится ошибка доступа
• 0 — метод получит стадии «Моего плана» текущего пользователя || || isAdmin boolean | Если установлено true, то проверки прав происходить не будет. При условии, что запрашивающий является администратором портала || |#

Примеры кода

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

{% list tabs %}

• cURL (Webhook)

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

• cURL (OAuth)

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

• JS

  const entityId = 0;
  BX24.callMethod(
      'task.stages.get',
      {
          entityId: entityId,
      },
      function(res)
      {
          console.log(res);
      }
  );

• PHP

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

{% endlist %}

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

HTTP-Статус: 200

{
    "result": {
        "5": {
         "ID": "5",
         "TITLE": "Не спланированы",
         "SORT": "100",
         "COLOR": "00C4FB",
         "SYSTEM_TYPE": "NEW",
         "ENTITY_ID": "1",
         "ENTITY_TYPE": "U",
         "ADDITIONAL_FILTER": [],
         "TO_UPDATE": [],
         "TO_UPDATE_ACCESS": null
        },
        "6": {
         "ID": "6",
         "TITLE": "Сделаю на неделе",
         "SORT": "200",
         "COLOR": "47D1E2",
         "SYSTEM_TYPE": null,
         "ENTITY_ID": "1",
         "ENTITY_TYPE": "U",
         "ADDITIONAL_FILTER": [],
         "TO_UPDATE": [],
         "TO_UPDATE_ACCESS": null
        }
    }
}

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

#| || Поле тип | Описание || || result object | Объект, содержащий данные о стадиях Канбана / Моего плана, ключами которого являются идентификаторы стадий || || ID integer | Идентификатор стадии || || TITLE string | Название || || SORT integer | Сортировка || || COLOR string | Цвет в формате RGB || || SYSTEM_TYPE string | Системный тип. Возможные значения: NEW, PROGRESS, WORK, REVIEW, FINISH || || ENTITY_ID integer | Идентификатор объекта, то есть группы или пользователя || || ENTITY_TYPE string | Тип объекта. U для пользователя, G для группы || || ADDITIONAL_FILTER array | Дополнительные фильтры.

Системный параметр. Всегда имеет значение пустого массива || || TO_UPDATE array | Массив элементов для обновления.

Системный параметр. Всегда имеет значение пустого массива || || TO_UPDATE_ACCESS null | Функции, применяемые к задаче при переносе на эту стадию.

Системный параметр. Всегда имеет значение null || |#

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

HTTP-статус: 400

{
    "error": "ACCESS_DENIED",
    "error_description": "Вы не можете просматривать стадии в этой группе"
}

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

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

#| || Код | Значение || || ACCESS_DENIED | Вы не можете просматривать стадии в этой группе || |#

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

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

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