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

Получить размещение задачи в скраме

GET /v1/scrum/tasks/:taskId

Возвращает текущую скрам-строку задачи. Используйте перед перемещением, чтобы узнать размещение, или после изменения, чтобы убедиться, что оно применилось.

Параметры

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

Примеры

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

Terminal 
curl https://vibecode.bitrix24.tech/v1/scrum/tasks/59 \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl https://vibecode.bitrix24.tech/v1/scrum/tasks/59 \
  -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/tasks/59', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
console.log('Размещение:', data)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/scrum/tasks/59', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { data } = await res.json()

Поля ответа

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

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

404 — задача не размещена в скраме или не существует:

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

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS ОписаниеtaskId не является положительным целым числом
HTTP404 КодENTITY_NOT_FOUND ОписаниеЗадача не найдена или не размещена в скраме
HTTP403 КодSCOPE_DENIED ОписаниеУ ключа нет скоупа task
HTTP401 КодTOKEN_MISSING ОписаниеУ ключа нет настроенных токенов

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

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