Этапы Scrum-канбана

Колонки доски спринта: создание, чтение и изменение. Этапы принадлежат спринту, а не рабочей группе — у разных спринтов одного проекта наборы колонок независимы.

Скоуп: task | Базовый URL: https://vibecode.bitrix24.tech/v1 | Авторизация: X-Api-Key

Как получить `sprintId`

Всем операциям с этапами нужен идентификатор спринта. Возьмите его в списке спринтов или запросите активный спринт проекта.

Список этапов

GET /v1/scrum/sprints/:sprintId/stages

Возвращает колонки доски одного спринта. У запланированного спринта, доска которого ещё не создана, вернётся пустой массив — это не ошибка.

Параметры пути

Общий параметр filter этим эндпоинтом не применяется. По умолчанию API сохраняет прежний ответ HTTP 200 и прежние данные, добавляет заголовок Warning: 299 - "filter is not supported on this endpoint and was ignored", а сервер фиксирует использование неподдерживаемого фильтра в журнале.

Примеры

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

curl https://vibecode.bitrix24.tech/v1/scrum/sprints/11/stages \
  -H "X-Api-Key: YOUR_API_KEY"

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

curl https://vibecode.bitrix24.tech/v1/scrum/sprints/11/stages \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

const res = await fetch('https://vibecode.bitrix24.tech/v1/scrum/sprints/11/stages', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { data } = await res.json()
console.log(data.map((stage) => stage.name))

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

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

const { data } = await res.json()
console.log(data.map((stage) => stage.name))

Поля ответа

Поля id, sort и sprintId приходят числами. Значение, не являющееся десятичным целым, приходит как null.

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

{
    "success": true,
    "data": [
        { "id": 431, "name": "Новые", "sort": 100, "type": "NEW", "sprintId": 11, "color": "00C4FB" },
        { "id": 433, "name": "Выполняются", "sort": 200, "type": "WORK", "sprintId": 11, "color": "47D1E2" },
        { "id": 435, "name": "Сделаны", "sort": 300, "type": "FINISH", "sprintId": 11, "color": "75D900" }
    ]
}

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

404 — спринта с таким ID не существует:

{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Sprint not found"
  }
}

Ошибки

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

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

• Нужен именно sprintId. ID рабочей группы или бэклога Битрикс24 не примет и ответит 404 — сообщение при этом не подсказывает, что передан идентификатор другого рода.

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

• Создать этап
• Обновить этап
• Этапы Scrum-канбана