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

Scope: task

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

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

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

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

Обязательные параметры отмечены *

Название
тип

Описание

entityId*
integer

Идентификатор объекта.

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

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

isAdmin
boolean

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

Примеры кода

Как использовать примеры в документации

curl -X POST \
        -H "Content-Type: application/json" \
        -d '{
        "entityId": 0
        }' \
        https://your-domain.bitrix24.com/rest/_USER_ID_/_CODE_/task.stages.get
        
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
        
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);
        }
        
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();
        }
        
const entityId = 0;
        BX24.callMethod(
            'task.stages.get',
            {
                entityId: entityId,
            },
            function(res)
            {
                console.log(res);
            }
        );
        
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": "Вы не можете просматривать стадии в этой группе"
        }

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код

Значение

ACCESS_DENIED

Вы не можете просматривать стадии в этой группе

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Предыдущая
Обновить стадию канбана или «Моего плана»
Следующая
Проверить возможность перемещения задачи