Блог Горошко Андрея Bitrix24,PHP Получить стадии канбана по идентификатору спринта tasks.api.scrum.kanban.getS…

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

Эффективная интеграция и кастомизация функционала в Битрикс24 часто требует работы на уровне API. Сегодня мы подробно рассмотрим «Получить стадии канбана по идентификатору спринта tasks.api.scrum.kanban.getS…». Вы узнаете экспертные методики работы с tasks.api.scrum.kanban.getStages и научитесь избегать типичных ошибок начинающих разработчиков.

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

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

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

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

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

Примеры кода

  • cURL (Webhook)
    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 (OAuth)
    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
  • JS
    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);
    }
  • PHP
    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.js
    BX24.callMethod(
        'tasks.api.scrum.kanban.getStages',
        {
            "sprintId": 5,
        },
        function(result) {
            if (result.error()) {
                console.error(result.error());
            } else {
                console.info(result.data());
            }
        }
    );
  • PHP CRest
    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"
}

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

КодОписаниеЗначение
0Sprint id not foundНе заполнено обязательное поле sprintId
0Sprint not foundПередан неизвестный идентификатор спринта sprintId
0Access deniedДоступ запрещен
0Неизвестная ошибка
  • [](./index)
  • [](./tasks-api-scrum-kanban-add-stage)
  • [](./tasks-api-scrum-kanban-update-stage)
  • [](./tasks-api-scrum-kanban-add-task)
  • [](./tasks-api-scrum-kanban-delete-stage)
  • [](./tasks-api-scrum-kanban-delete-task)
  • [](./tasks-api-scrum-kanban-get-fields)

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

Советы эксперта по интеграции:

  • Всегда используйте кэширование при частых запросах к tasks.api.scrum.kanban.getStages, чтобы разгрузить базу данных.
  • Соблюдайте стандарты PSR при написании обработчиков для «Получить стадии канбана по идентификатору спринта tasks.api.scrum.kanban.getS…».
  • Регулярно проводите аудит производительности системы с помощью встроенного монитора 1С-Битрикс.

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

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

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

Related Post

Получить основные настройки календаря calendar.settings.getПолучить основные настройки календаря calendar.settings.get

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

Переместить файл в корзину disk.file.markdeletedПереместить файл в корзину disk.file.markdeleted

Эффективная интеграция и кастомизация функционала в Битрикс24 часто требует работы на уровне API. Сегодня мы подробно рассмотрим «Переместить файл в корзину disk.file.markdeleted». Вы узнаете экспертные методики работы с disk.file.markdeleted и

Получить ресурс booking.v1.resource.getПолучить ресурс booking.v1.resource.get

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