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

Создать стадию канбана Скрама tasks.api.scrum.kanban.addStage

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

Метод создает стадию канбана Скрама.

Канбан Скрама обязательно должен содержать в себе стадии с типом новая NEW и финальная FINISH.

Используйте метод только для активных спринтов, то есть с полем "status": "active".

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

Параметр fields

Примеры кода

• cURL (Webhook)

    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"fields":{"sprintId":1,"name":"Первая стадия","type":"NEW","color":"00C4FB","sort":100}}' \
    https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/tasks.api.scrum.kanban.addStage

• cURL (OAuth)

    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"fields":{"sprintId":1,"name":"Первая стадия","type":"NEW","color":"00C4FB","sort":100},"auth":"**put_access_token_here**"}' \
    https://**put_your_bitrix24_address**/rest/tasks.api.scrum.kanban.addStage

• JS

    try
    {
    	const response = await $b24.callMethod(
    		'tasks.api.scrum.kanban.addStage',
    		{
    			"fields": {
    				"sprintId": 1,
    				"name": "Первая стадия",
    				"type": "NEW",
    				"color": "00C4FB",
    				"sort": 100,
    			},
    		}
    	);
    	
    	const result = response.getData().result;
    	console.info(result);
    }
    catch( error )
    {
    	console.error(error);
    }

• PHP

    try {
        $response = $b24Service
            ->core
            ->call(
                'tasks.api.scrum.kanban.addStage',
                [
                    'fields' => [
                        'sprintId' => 1,
                        'name' => 'Первая стадия',
                        'type' => 'NEW',
                        'color' => '00C4FB',
                        'sort' => 100,
                    ],
                ]
            );
    
        $result = $response
            ->getResponseData()
            ->getResult();
    
        echo 'Success: ' . print_r($result, true);
        // Нужная вам логика обработки данных
        processData($result);
    
    } catch (Throwable $e) {
        error_log($e->getMessage());
        echo 'Error adding stage: ' . $e->getMessage();
    }

• BX24.js

    BX24.callMethod(
        'tasks.api.scrum.kanban.addStage',
        {
            "fields": {
                "sprintId": 1,
                "name": "Первая стадия",
                "type": "NEW",
                "color": "00C4FB",
                "sort": 100,
            },
        },
        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.addStage',
        [
            'fields' => [
                'sprintId' => 1,
                'name' => 'Первая стадия',
                'type' => 'NEW',
                'sort' => 100,
                'color' => '00C4FB',
            ],
        ]
    );

    echo '<PRE>';
    print_r($result);
    echo '</PRE>';

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

HTTP-статус: 200

{
    "result": 5,
    "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"
    }
}

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

HTTP-статус: 400

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

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

• [](./index)
• [](./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-get-stages)