Для AI-агентов: markdown этой страницы — /docs-content/scrum/sprints/active.md индекс документации — /llms.txt

Активный спринт

GET /v1/scrum/sprints/active

Возвращает текущий активный спринт одного скрам-проекта. Если активного спринта сейчас нет, запрос остаётся успешным и возвращает data: null.

Параметры

Параметр Тип Обяз. Описание
ПараметрgroupId (query) Типnumber Обяз.да ОписаниеID скрам-проекта. Получите его через GET /v1/workgroups

Примеры

curl — личный ключ

Terminal 
curl "https://vibecode.bitrix24.tech/v1/scrum/sprints/active?groupId=45" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal 
curl "https://vibecode.bitrix24.tech/v1/scrum/sprints/active?groupId=45" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/scrum/sprints/active?groupId=45', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { data: sprint } = await res.json()
console.log(sprint?.name ?? 'Активного спринта нет')

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/scrum/sprints/active?groupId=45', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { data: sprint } = await res.json()
console.log(sprint?.name ?? 'Активного спринта нет')

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata Типobject | null ОписаниеАктивный спринт или null, если его нет
Полеdata.id Типnumber ОписаниеID спринта. Он же sprintId в операциях с этапами
Полеdata.groupId Типnumber ОписаниеID скрам-проекта
Полеdata.entityType Типstring ОписаниеТип записи, sprint
Полеdata.name Типstring ОписаниеНазвание спринта
Полеdata.goal Типstring ОписаниеЦель спринта
Полеdata.sort Типnumber ОписаниеПорядок спринта внутри проекта
Полеdata.createdBy Типnumber ОписаниеID автора спринта
Полеdata.modifiedBy Типnumber ОписаниеID сотрудника, изменившего спринт последним
Полеdata.dateStart Типstring ОписаниеНачало спринта в формате ISO 8601
Полеdata.dateEnd Типstring ОписаниеОкончание спринта в формате ISO 8601
Полеdata.status Типstring ОписаниеДля найденной записи всегда active

Пример ответа

JSON 
{
  "success": true,
  "data": {
    "id": 11,
    "groupId": 45,
    "entityType": "sprint",
    "name": "Спринт 3",
    "goal": "",
    "sort": 0,
    "createdBy": 29,
    "modifiedBy": 29,
    "dateStart": "2023-09-15T01:00:00+03:00",
    "dateEnd": "2023-09-29T01:00:00+03:00",
    "status": "active"
  }
}

Пример ответа при ошибке

400 — groupId не передан:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "groupId must be a positive integer"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS ОписаниеgroupId не передан или не является положительным целым числом
HTTP401 КодTOKEN_MISSING ОписаниеУ ключа нет настроенных токенов
HTTP403 КодSCOPE_DENIED ОписаниеКлючу не хватает скоупа task
HTTP422 КодBITRIX_ERROR ОписаниеБитрикс24 отказал в чтении спринтов проекта

Полный список общих ошибок API — Ошибки.

Известные особенности

  • У одного скрам-проекта может быть не больше одного активного спринта.
  • Отсутствие активного спринта — нормальное состояние проекта, поэтому ответ содержит data: null, а не ошибку 404.

Смотрите также