Для AI-агентов: markdown этой страницы — /docs-content/scrum/metrics/burn-down.md индекс документации — /llms.txt
Получить данные для графика сгорания
GET /v1/scrum/groups/:groupId/burn-down
Возвращает спринт скрам-проекта, по которому строится график сгорания задач: текущий активный спринт, а без него — последний завершённый.
Параметры
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
ПараметрgroupId (path) |
Типnumber | Обяз.да | ОписаниеID скрам-проекта. Список: GET /v1/workgroups |
Примеры
curl — личный ключ
curl "https://vibecode.bitrix24.tech/v1/scrum/groups/45/burn-down" \
-H "X-Api-Key: YOUR_API_KEY"
curl — OAuth-приложение
curl "https://vibecode.bitrix24.tech/v1/scrum/groups/45/burn-down" \
-H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN"
JavaScript — личный ключ
const res = await fetch('https://vibecode.bitrix24.tech/v1/scrum/groups/45/burn-down', {
headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
console.log(data.sprint ? `${data.sprint.name}: ${data.sprint.status}` : 'Спринтов нет')
JavaScript — OAuth-приложение
const res = await fetch('https://vibecode.bitrix24.tech/v1/scrum/groups/45/burn-down', {
headers: {
'X-Api-Key': 'YOUR_APP_KEY',
'Authorization': 'Bearer USER_SESSION_TOKEN',
},
})
const { data } = await res.json()
console.log(data.sprint ? `${data.sprint.name}: ${data.sprint.status}` : 'Спринтов нет')
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
Полеsuccess |
Типboolean | ОписаниеВсегда true при успехе |
Полеdata.sprint |
Типobject | null | ОписаниеСпринт для графика или null, если у проекта нет ни активного, ни завершённого спринта. Рабочая группа без скрама, в которой состоит пользователь, тоже отвечает null |
Полеdata.sprint.id |
Типnumber | ОписаниеID спринта. Подробные данные: GET /v1/scrum/sprints/:id |
Полеdata.sprint.groupId |
Типnumber | ОписаниеID скрам-проекта |
Полеdata.sprint.entityType |
Типstring | ОписаниеТип записи, sprint |
Полеdata.sprint.name |
Типstring | ОписаниеНазвание спринта |
Полеdata.sprint.sort |
Типnumber | ОписаниеПорядок спринта внутри проекта |
Полеdata.sprint.createdBy |
Типnumber | ОписаниеID автора спринта. Список: GET /v1/users |
Полеdata.sprint.modifiedBy |
Типnumber | ОписаниеID сотрудника, изменившего спринт последним. Список: GET /v1/users |
Полеdata.sprint.dateStart |
Типstring | ОписаниеНачало спринта в формате ISO 8601 |
Полеdata.sprint.dateEnd |
Типstring | ОписаниеОкончание спринта в формате ISO 8601 |
Полеdata.sprint.status |
Типstring | Описаниеactive — спринт идёт, completed — завершён |
Полеdata.sprint.info |
Типobject | ОписаниеНа проверенных спринтах — пустой объект |
Полеdata.sprint.children |
Типarray | ОписаниеНа проверенных спринтах — пустой массив |
Полеdata.sprint.tmpId |
Типstring | ОписаниеНа проверенных спринтах — пустая строка |
Пример ответа
Активный спринт:
{
"success": true,
"data": {
"sprint": {
"id": 11,
"groupId": 45,
"entityType": "sprint",
"name": "Спринт 3",
"sort": 0,
"createdBy": 29,
"modifiedBy": 29,
"dateStart": "2023-09-15T01:00:00+03:00",
"dateEnd": "2023-09-29T01:00:00+03:00",
"status": "active",
"info": {},
"children": [],
"tmpId": ""
}
}
}
Проект без спринтов:
{
"success": true,
"data": {
"sprint": null
}
}
Пример ответа при ошибке
422 — проект не существует или у пользователя нет к нему доступа:
{
"success": false,
"error": {
"code": "BITRIX_ERROR",
"message": "У вас нет доступа.",
"b24Code": "TASKS_SCS_02"
}
}
Ошибки
| HTTP | Код | Описание |
|---|---|---|
| HTTP400 | КодINVALID_PARAMS |
ОписаниеgroupId не является положительным целым числом |
| HTTP401 | КодMISSING_API_KEY |
ОписаниеНе передан X-Api-Key |
| HTTP401 | КодTOKEN_MISSING |
ОписаниеУ ключа нет настроенных токенов |
| HTTP403 | КодSCOPE_DENIED |
ОписаниеКлючу не хватает скоупа task |
| HTTP422 | КодBITRIX_ERROR |
ОписаниеПроект не существует или у пользователя нет к нему доступа. В error.b24Code — TASKS_SCS_02 |
Полный список общих ошибок API — Ошибки.
Известные особенности
- Точки графика строятся по задачам спринта и их story points: задачи проекта отдаёт
GET /v1/tasks?filter[groupId]=45, спринт и story points задачи —GET /v1/scrum/tasks/:taskId.