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

Разместить или переместить задачу в скраме

PATCH /v1/scrum/tasks/:taskId

Размещает задачу в скраме и перемещает её между бэклогом, спринтом и эпиком, задаёт стори-поинты и порядок сортировки. Передавайте только изменяемые поля.

Параметры

Параметр Тип Обяз. Описание
ПараметрtaskId Типnumber Обяз.да ОписаниеID задачи (path-параметр). Источник: GET /v1/tasks

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

Хотя бы одно поле обязательно.

Поле Тип Описание
ПолеepicId Типnumber ОписаниеПривязка к эпику. 0 — отвязать от эпика. Источник: GET /v1/scrum/epics
ПолеentityId Типnumber ОписаниеID бэклога или спринта. Определяется автоматически — передавайте явно только чтобы положить задачу в конкретный спринт
ПолеstoryPoints Типstring | number ОписаниеСтори-поинты, например "3" или "0.5". Пустая строка очищает
Полеsort Типnumber ОписаниеПозиция в списке
ПолеsortFloat Типnumber ОписаниеПозиция в списке. Приоритетнее sort
ПолеmodifiedBy Типnumber ОписаниеID автора изменения. Источник: GET /v1/users. createdBy размещения не изменяется

Примеры

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

Terminal 
curl -X PATCH https://vibecode.bitrix24.tech/v1/scrum/tasks/59 \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "epicId": 11, "storyPoints": "3" }'

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

Terminal 
curl -X PATCH https://vibecode.bitrix24.tech/v1/scrum/tasks/59 \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "epicId": 11, "storyPoints": "3" }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/scrum/tasks/59', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ epicId: 11, storyPoints: '3' }),
})
const { data } = await res.json()
console.log('Размещение:', data)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/scrum/tasks/59', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ epicId: 11, storyPoints: '3' }),
})
const { data } = await res.json()

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata Типobject ОписаниеРазмещение задачи после изменения
Полеdata.entityId Типnumber ОписаниеID бэклога или спринта, в котором лежит задача
Полеdata.epicId Типnumber ОписаниеID эпика. 0 — задача не привязана к эпику
Полеdata.storyPoints Типstring ОписаниеСтори-поинты, например "3". Пустая строка — не заданы
Полеdata.sort Типnumber ОписаниеПозиция в списке
Полеdata.sortFloat Типnumber ОписаниеПозиция в списке. Приоритетнее sort
Полеdata.createdBy Типnumber ОписаниеID автора размещения
Полеdata.modifiedBy Типnumber ОписаниеID автора последнего изменения
Полеdata.groupId Типnumber ОписаниеID скрам-проекта задачи. Список: GET /v1/workgroups

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

JSON 
{
  "success": true,
  "data": {
    "entityId": 1,
    "storyPoints": "3",
    "epicId": 11,
    "sort": 255,
    "sortFloat": 512,
    "createdBy": 1,
    "modifiedBy": 1,
    "groupId": 45
  }
}

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

400 — у задачи нет рабочей группы, авторазмещение в бэклог невозможно:

JSON 
{
  "success": false,
  "error": {
    "code": "TASK_NOT_IN_GROUP",
    "message": "Task 289 has no workgroup (GROUP_ID), so it cannot be placed in scrum. Move the task into a scrum project first (PATCH /v1/tasks/:id { \"groupId\": N }) or pass entityId explicitly."
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS ОписаниеПустое тело, нечисловое поле или попытка задать createdBy
HTTP400 КодTASK_NOT_IN_GROUP ОписаниеentityId не передан, а у задачи нет рабочей группы или задачи с таким taskId не существует — авторазмещение в бэклог невозможно. Перенесите задачу в скрам-проект через PATCH /v1/tasks/:id { "groupId": N } или передайте entityId явно
HTTP404 КодENTITY_NOT_FOUND ОписаниеentityId передан, а задачи с таким taskId не существует
HTTP422 КодBACKLOG_NOT_RESOLVED ОписаниеРабочая группа задачи — не скрам-проект, бэклог не найден
HTTP422 КодBITRIX_ERROR ОписаниеПрочая ошибка Битрикс24, например groupId эпика и задачи не совпадают
HTTP403 КодSCOPE_DENIED ОписаниеУ ключа нет скоупа task
HTTP403 КодWRITE_BLOCKED_READONLY_KEY ОписаниеКлюч в режиме «только чтение»
HTTP401 КодTOKEN_MISSING ОписаниеУ ключа нет настроенных токенов

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

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

  • Бэклог определяется автоматически. Если entityId опущен и задача ещё не в скраме, API находит бэклог скрам-проекта задачи по её рабочей группе и кладёт задачу туда. Задача, уже размещённая в скраме, сохраняет текущий бэклог или спринт.
  • Доступ. Размещать задачи может только пользователь Битрикс24, от имени которого работает ключ, с доступом к скрам-проекту задачи. Иначе портал вернёт 422 BITRIX_ERROR с сообщением «Access denied».

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