Получить поля спринта по его идентификатору tasks.api.scrum.sprint.get
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
taskКто может выполнять метод: любой пользователь
Метод tasks.api.scrum.sprint.get возвращает значения полей спринта по его идентификатору.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
sprintId* |
Идентификатор спринта. Идентификатор можно получить методом tasks.api.scrum.sprint.list |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"id": 2
}' \
https://your-domain.bitrix24.com/rest/_USER_ID_/_CODE_/tasks.api.scrum.sprint.get
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"id": 2,
"auth": "YOUR_ACCESS_TOKEN"
}' \
https://your-domain.bitrix24.com/rest/tasks.api.scrum.sprint.get
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type SprintGetResult = {
id: number
groupId: number
entityType: string
name: string
goal: string
sort: number
createdBy: number
modifiedBy: number
dateStart: ISODate | null
dateEnd: ISODate | null
status: string
}
try {
const response = await $b24.actions.v2.call.make<SprintGetResult>({
method: 'tasks.api.scrum.sprint.get',
params: {
id: 2,
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info(result.id, result.name, result.status)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function getSprintById() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'tasks.api.scrum.sprint.get',
params: {
id: 2,
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info(result.id, result.name, result.status)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getSprintById)
</script>
try {
$sprintId = 2;
$response = $b24Service
->core
->call(
'tasks.api.scrum.sprint.get',
[
'id' => $sprintId,
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Нужная вам логика обработки данных
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting sprint data: ' . $e->getMessage();
}
const sprintId = 2;
BX24.callMethod(
'tasks.api.scrum.sprint.get',
{
id: sprintId,
},
function(res)
{
console.log(res);
}
);
require_once('crest.php'); // подключение CRest PHP SDK
$sprintId = 2;
// выполнение запроса к REST API
$result = CRest::call(
'tasks.api.scrum.sprint.get',
[
'id' => $sprintId
]
);
// Обработка ответа от Битрикс24
if ($result['error']) {
echo 'Error: '.$result['error_description'];
} else {
print_r($result['result']);
}
Обработка ответа
HTTP-статус: 200
{
"result":
{
"id": 2,
"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": "planned"
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Объект, содержащий данные о спринте |
|
id |
Идентификатор спринта |
|
groupId |
Идентификатор группы (Скрама), к которой относится спринт |
|
entityType |
Тип сущности (в данном случае |
|
name |
Название спринта |
|
goal |
Цель спринта. Устанавливается только в интерфейсе при запуске спринта |
|
sort |
Сортировка |
|
createdBy |
Идентификатор пользователя, создавшего спринт |
|
modifiedBy |
Идентификатор пользователя, изменившего спринт |
|
dateStart |
Дата начала спринта в формате |
|
dateEnd |
Дата окончания спринта в формате |
|
status |
Статус спринта |
Обработка ошибок
HTTP-статус: 400
{
"error": 0,
"error_description": "Sprint not found"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Cообщение об ошибке |
Описание |
|
|
|
Нет доступа для просмотра данных спринта |
|
|
|
Такого спринта не существует |
|
|
|
Неверно указано имя параметра или не задан параметр |
|
|
|
Неверный тип параметра |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Добавить спринт в Скрам tasks.api.scrum.sprint.add
- Изменить спринт tasks.api.scrum.sprint.update
- Запустить спринт tasks.api.scrum.sprint.start
- Завершить активный спринт выбранного Скрама tasks.api.scrum.sprint.complete
- Получить список спринтов tasks.api.scrum.sprint.list
- Удалить спринт tasks.api.scrum.sprint.delete
- Получить список доступных полей спринта tasks.api.scrum.sprint.getFields