Блог Горошко Андрея Bitrix24,PHP Получить список стадий канбана или «Моего плана» task.stages.get

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

Оптимизация производительности и безопасности — залог успешного проекта на 1С-Битрикс. Данный материал посвящен практическому применению «Получить список стадий канбана или «Моего плана» task.stages.get». Мы подготовили подробный разбор принципов работы и развернутые примеры интеграции.

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

> Scope: task
>
> Кто может выполнять метод:
> — любой пользователь для стадий «Моего плана»
> — любой пользователь с доступом к группе для стадий канбана

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

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

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

Возможные значения:
— ID группы — метод получит стадии канбана группы. При недостаточном уровне прав выводится ошибка доступа
— 0 — метод получит стадии «Моего плана» текущего пользователя

isAdmin
boolean
Если установлено true, то проверки прав происходить не будет. При условии, что запрашивающий является администратором портала

Примеры кода

  • 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
    try
    {
    	const response = await $b24.callMethod(
    		'task.stages.get',
    		{
    			entityId: entityId,
    		}
    	);
    	
    	const result = response.getData().result;
    	console.log(result);
    }
    catch( error )
    {
    	console.error('Error:', error);
    }
  • PHP
    try {
        $response = $b24Service
            ->core
            ->call(
                'task.stages.get',
                [
                    'entityId' => $entityId,
                ]
            );
    
        $result = $response
            ->getResponseData()
            ->getResult();
    
        echo 'Success: ' . print_r($result, true);
    
    } catch (Throwable $e) {
        error_log($e->getMessage());
        echo 'Error getting task stages: ' . $e->getMessage();
    }
  • BX24.js
    const entityId = 0;
    BX24.callMethod(
        'task.stages.get',
        {
            entityId: entityId,
        },
        function(res)
        {
            console.log(res);
        }
    );
  • PHP CRest
    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']);
    }

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

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": "Вы не можете просматривать стадии в этой группе"
}

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

КодЗначение
ACCESS_DENIEDВы не можете просматривать стадии в этой группе
  • [](./index)
  • [](./task-stages-add)
  • [](./task-stages-update)
  • [](./task-stages-can-move-task)
  • [](./task-stages-move-task)
  • [](./task-stages-delete)

💡 Экспертное мнение и рекомендации

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

Использование современных стандартов D7 при работе с task.stages.get позволяет писать чистый, масштабируемый и безопасный код. Не забывайте обрабатывать исключения (try/catch) и проверять права доступа текущего пользователя перед выполнением критических операций.

Похожая задача в бизнесе?

Помогу автоматизировать процессы и внедрить ИИ

Меня зовут Андрей Горошко. Я Full-stack разработчик и эксперт по 1С-Битрикс. Настраиваю CRM Битрикс24, разрабатываю защищенные API и создаю умных ИИ-агентов для автоматизации рутины.

Related Post

Cache section: Подробное руководствоCache section: Подробное руководство

Каждый PHP-разработчик, работающий с экосистемой Bitrix Framework, должен глубоко понимать работу её ключевых компонентов. В этой статье мы проведем подробный аудит темы «Cache section: Подробное руководство», проанализируем лучшие практики и

Как использовать D7AssetUse() в 1С-Битрикс: пример кодаКак использовать D7AssetUse() в 1С-Битрикс: пример кода

Оптимизация производительности и безопасности — залог успешного проекта на 1С-Битрикс. Данный материал посвящен практическому применению «Как использовать D7AssetUse() в 1С-Битрикс: пример кода». Мы подготовили подробный разбор принципов работы и развернутые

Получить описание полей для пользовательского поля типа «enumeration» (список…Получить описание полей для пользовательского поля типа «enumeration» (список…

Каждый PHP-разработчик, работающий с экосистемой Bitrix Framework, должен глубоко понимать работу её ключевых компонентов. В этой статье мы проведем подробный аудит темы «Получить описание полей для пользовательского поля типа «enumeration»