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

Бэклоги Scrum

Создание, изменение и удаление бэклога Scrum-проекта. У проекта один бэклог, задачи попадают в него через размещение задачи в скраме.

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

Создать бэклог

POST /v1/scrum/backlogs

Создаёт бэклог в Scrum-проекте, у которого его нет. Тело запроса плоское, без обёртки fields.

Поля запроса (body)

Поле Тип Обяз. Описание
ПолеgroupId Типnumber Обяз.да ОписаниеID Scrum-проекта. Список групп: GET /v1/workgroups
ПолеcreatedBy Типnumber Обяз.да ОписаниеID пользователя-создателя. Список: GET /v1/users
ПолеmodifiedBy Типnumber Обяз.нет ОписаниеID пользователя, изменившего бэклог. Список: GET /v1/users

Без createdBy бэклог не создаётся: приходит 422 BITRIX_ERROR с сообщением Unable to add backlog.

Примеры

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/scrum/backlogs \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "groupId": 175, "createdBy": 1 }'

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/scrum/backlogs \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "groupId": 175, "createdBy": 1 }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/scrum/backlogs', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ groupId: 175, createdBy: 1 }),
})

const { data } = await res.json()
console.log('Backlog ID:', data.id)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/scrum/backlogs', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ groupId: 175, createdBy: 1 }),
})

const { data } = await res.json()
console.log('Backlog ID:', data.id)

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean Описаниеtrue при успешном создании, HTTP-статус 201
Полеdata.id Типnumber ОписаниеID созданного бэклога
Полеdata.groupId Типnumber ОписаниеID Scrum-проекта
Полеdata.createdBy Типnumber ОписаниеID пользователя-создателя
Полеdata.modifiedBy Типnumber ОписаниеID пользователя, изменившего бэклог. 0, если modifiedBy не передан

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

JSON 
{
  "success": true,
  "data": {
    "id": 43,
    "groupId": 175,
    "createdBy": 1,
    "modifiedBy": 0
  }
}

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

422 — у проекта уже есть бэклог:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Backlog already added",
    "b24Code": "0"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS ОписаниеНе передан groupId, передано поле вне таблицы или ID не положительное целое
HTTP422 КодBITRIX_ERROR ОписаниеBacklog already added — у проекта уже есть бэклог
HTTP422 КодBITRIX_ERROR ОписаниеUnable to add backlog — не передан createdBy или группа не Scrum-проект
HTTP422 КодBITRIX_ERROR ОписаниеAccess denied — группы с таким ID нет или к ней нет доступа
HTTP403 КодSCOPE_DENIED ОписаниеКлючу не хватает скоупа task
HTTP403 КодWRITE_BLOCKED_READONLY_KEY ОписаниеКлюч работает только на чтение
HTTP401 КодTOKEN_MISSING ОписаниеУ ключа нет настроенных токенов

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

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