## Получить данные для графика сгорания

`GET /v1/scrum/groups/:groupId/burn-down`

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

## Параметры

| Параметр | Тип | Обяз. | Описание |
|----------|-----|-------|----------|
| `groupId` (path) | number | да | ID скрам-проекта. Список: [`GET /v1/workgroups`](/docs/entities/workgroups/list) |

## Примеры

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

```bash
curl "https://vibecode.bitrix24.tech/v1/scrum/groups/45/burn-down" \
  -H "X-Api-Key: YOUR_API_KEY"
```

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

```bash
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 — личный ключ

```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-приложение

```javascript
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`](/docs/scrum/sprints/get) |
| `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`](/docs/entities/users/list) |
| `data.sprint.modifiedBy` | number | ID сотрудника, изменившего спринт последним. Список: [`GET /v1/users`](/docs/entities/users/list) |
| `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 | На проверенных спринтах — пустая строка |

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

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

```json
{
  "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": ""
    }
  }
}
```

Проект без спринтов:

```json
{
  "success": true,
  "data": {
    "sprint": null
  }
}
```

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

422 — проект не существует или у пользователя нет к нему доступа:

```json
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "У вас нет доступа.",
    "b24Code": "TASKS_SCS_02"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|----------|
| 400 | `INVALID_PARAMS` | `groupId` не является положительным целым числом |
| 401 | `MISSING_API_KEY` | Не передан `X-Api-Key` |
| 401 | `TOKEN_MISSING` | У ключа нет настроенных токенов |
| 403 | `SCOPE_DENIED` | Ключу не хватает скоупа `task` |
| 422 | `BITRIX_ERROR` | Проект не существует или у пользователя нет к нему доступа. В `error.b24Code` — `TASKS_SCS_02` |

Полный список общих ошибок API — [Ошибки](/docs/errors).

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

- Точки графика строятся по задачам спринта и их story points: задачи проекта отдаёт [`GET /v1/tasks?filter[groupId]=45`](/docs/entities/tasks/list), спринт и story points задачи — [`GET /v1/scrum/tasks/:taskId`](/docs/scrum/tasks/get).

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

- [Проверить, есть ли завершённый спринт](/docs/scrum/metrics/team-speed)
- [Активный спринт](/docs/scrum/sprints/active)
- [Список спринтов](/docs/scrum/sprints/list)
- [Метрики спринта](/docs/scrum/metrics)
