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

Обновить бэклог

PATCH /v1/scrum/backlogs/:id

Меняет поля бэклога Scrum-проекта. Частичное обновление — передавайте только то, что меняется.

Параметры

Параметр Тип Обяз. Описание
Параметрid (path) Типnumber Обяз.да ОписаниеID бэклога, а не ID группы. Где взять — Бэклоги Scrum

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

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

Нужно хотя бы одно поле.

Примеры

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

Terminal 
curl -X PATCH https://vibecode.bitrix24.tech/v1/scrum/backlogs/43 \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "modifiedBy": 1 }'

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

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

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

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

const { data } = await res.json()
console.log(data.modifiedBy)

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

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

const { data } = await res.json()
console.log(data.modifiedBy)

Поля ответа

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

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

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

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

404 — бэклога с таким ID нет:

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

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS ОписаниеПустое тело, поле вне таблицы или ID не положительное целое
HTTP404 КодENTITY_NOT_FOUND ОписаниеБэклога с таким id нет
HTTP422 КодBITRIX_ERROR ОписаниеcreatedBy user not found — пользователя с таким ID нет
HTTP403 КодSCOPE_DENIED ОписаниеКлючу не хватает скоупа task
HTTP403 КодWRITE_BLOCKED_READONLY_KEY ОписаниеКлюч работает только на чтение
HTTP401 КодTOKEN_MISSING ОписаниеУ ключа нет настроенных токенов

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

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