Получить стадии канбана по идентификатору спринта tasks.api.scrum.kanban.getStages

Если вы разрабатываете интеграции для Битрикс24 с помощью AI-инструментов (Codex, Claude Code, Cursor), подключите MCP-сервер, чтобы ассистент использовал официальную REST-документацию.

Scope: task

Кто может выполнять метод: любой пользователь

Метод возвращает стадии канбана по идентификатору спринта.

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

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

Название
тип

Описание

sprintId*
integer

Идентификатор спринта. Получить идентификатор можно при помощи метода tasks.api.scrum.sprint.list

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"sprintId":5}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/tasks.api.scrum.kanban.getStages
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"sprintId":5,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/tasks.api.scrum.kanban.getStages
        
try
        {
        	const response = await $b24.callMethod(
        		'tasks.api.scrum.kanban.getStages',
        		{
        			"sprintId": 5,
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'tasks.api.scrum.kanban.getStages',
                    [
                        'sprintId' => 5,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Нужная вам логика обработки данных
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting stages: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'tasks.api.scrum.kanban.getStages',
            {
                "sprintId": 5,
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'tasks.api.scrum.kanban.getStages',
            [
                'sprintId' => 5,
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": [
              {
                "id": "58",
                "name": "Новые",
                "sort": "100",
                "type": "NEW",
                "sprintId": "5",
                "color": "00C4FB"
              },
              {
                "id": "59",
                "name": "Выполняются",
                "sort": "200",
                "type": "WORK",
                "sprintId": "5",
                "color": "47D1E2"
              },
              {
                "id": "60",
                "name": "Сделаны",
                "sort": "300",
                "type": "FINISH",
                "sprintId": "5",
                "color": "75D900"
              }
            ],
            "time":{
                "start":1712137817.343984,
                "finish":1712137817.605804,
                "duration":0.26182007789611816,
                "processing":0.018325090408325195,
                "date_start":"2024-04-03T12:50:17+03:00",
                "date_finish":"2024-04-03T12:50:17+03:00"
            }
        }

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

Название
тип

Описание

id*
integer

Идентификатор стадии

name*
string

Название стадии канбана

type
string

Тип стадии канбана. Возможные значения: NEW, WORK, FINISH

sort
integer

Порядок сортировки

color
string

Цвет стадии канбана

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

HTTP-статус: 400

{
            "error":0,
            "error_description":"Sprint id not found"
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

Значение

0

Sprint id not found

Не заполнено обязательное поле sprintId

0

Sprint not found

Передан неизвестный идентификатор спринта sprintId

0

Access denied

Доступ запрещен

0

Неизвестная ошибка

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

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

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

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

Предыдущая
Обновить стадию канбана
Следующая
Удалить стадию