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

Завершить активный спринт выбранного Скрама tasks.api.scrum.sprint.complete

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

Метод tasks.api.scrum.sprint.complete завершает активный спринт выбранного Скрама.

При завершении спринта незавершенные задачи переносятся в бэклог.

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

Примеры кода

• cURL (Webhook)

    curl -X POST \
    -H "Content-Type: application/json" \
    -d '{
    "id": 1
    }' \
    https://your-domain.bitrix24.com/rest/_USER_ID_/_CODE_/tasks.api.scrum.sprint.complete

• cURL (oAuth)

    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Authorization: YOUR_ACCESS_TOKEN" \
    -d '{
    "id": 1
    }' \
    https://your-domain.bitrix24.com/rest/tasks.api.scrum.sprint.complete

• JS

    try
    {
    	const response = await $b24.callMethod(
    		'tasks.api.scrum.sprint.complete',
    		{
    			id: groupId
    		}
    	);
    	
    	const result = response.getData().result;
    	console.log(result);
    }
    catch( error )
    {
    	console.error('Error:', error);
    }

• PHP

    try {
        $response = $b24Service
            ->core
            ->call(
                'tasks.api.scrum.sprint.complete',
                [
                    'id' => $groupId
                ]
            );
    
        $result = $response
            ->getResponseData()
            ->getResult();
    
        echo 'Success: ' . print_r($result, true);
        // Нужная вам логика обработки данных
        processData($result);
    
    } catch (Throwable $e) {
        error_log($e->getMessage());
        echo 'Error completing sprint: ' . $e->getMessage();
    }

• BX24.js

    const groupId = 1;
    BX24.callMethod(
        'tasks.api.scrum.sprint.complete',
        {
            id: groupId
        },
        function(res)
        {
            console.log(res);
        }
    );

• PHP CRest

    require_once('crest.php'); // подключение CRest PHP SDK

    // выполнение запроса к REST API
    $result = CRest::call(
        'tasks.api.scrum.sprint.complete',
        [
            'id' => 1,
        ]
    );

    // Обработка ответа от Битрикс24
    if (isset($result['error'])) {
        echo 'Error: '.$result['error_description'];
    } else {
        print_r($result['result']);
    }

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

HTTP-статус: 200

{
    "result":
    {
        "id": 1,
        "groupId": 143,
        "entityType": "sprint",
        "name": "Спринт 1",
        "goal": "Цель",
        "sort": 1,
        "createdBy": 1,
        "modifiedBy": 1,
        "dateStart": "2024-07-19T15:03:01+00:00",
        "dateEnd": "2024-08-02T15:03:01+00:00",
        "status": "completed"
    }
}

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

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

HTTP-статус: 400

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

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

• [](./tasks-api-scrum-sprint-add)
• [](./tasks-api-scrum-sprint-update)
• [](./tasks-api-scrum-sprint-start)
• [](./tasks-api-scrum-sprint-get)
• [](./tasks-api-scrum-sprint-list)
• [](./tasks-api-scrum-sprint-delete)
• [](./tasks-api-scrum-sprint-get-fields)