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

Эпики скрама

Создание, чтение, переименование и перекраска эпиков скрам-проекта. Эпик группирует задачи внутри одной рабочей группы Битрикс24. Задачи привязываются к эпику через размещение задачи в скраме.

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

Создать эпик

POST /v1/scrum/epics

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

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

Поле Тип Обяз. Описание
name string да Название эпика. До 65 535 символов
groupId number да ID скрам-проекта (рабочей группы). Список: GET /v1/workgroups
description string нет Описание эпика. До 65 535 символов
color string нет Цвет эпика, например "#5eead4". До 64 символов
createdBy number нет ID автора. По умолчанию — пользователь, которому принадлежит ключ. Список: GET /v1/users

Примеры

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/scrum/epics \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "doc-verify create",
    "groupId": 45,
    "description": "Зеркало эпика из внешнего трекера",
    "color": "#5eead4"
  }'

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/scrum/epics \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "doc-verify create",
    "groupId": 45,
    "description": "Зеркало эпика из внешнего трекера",
    "color": "#5eead4"
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/scrum/epics', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'doc-verify create',
    groupId: 45,
    description: 'Зеркало эпика из внешнего трекера',
    color: '#5eead4',
  }),
})

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/scrum/epics', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'doc-verify create',
    groupId: 45,
    description: 'Зеркало эпика из внешнего трекера',
    color: '#5eead4',
  }),
})

const { data } = await res.json()

Поля ответа

Поле Тип Описание
id number ID созданного эпика
groupId number ID скрам-проекта
name string Название эпика
description string Описание эпика
color string Цвет эпика
createdBy number ID автора
modifiedBy number ID последнего изменившего. На создании равен 0

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

JSON 
{
    "success": true,
    "data": {
        "id": 11,
        "groupId": 45,
        "name": "doc-verify create",
        "description": "Зеркало эпика из внешнего трекера",
        "createdBy": 1,
        "modifiedBy": 0,
        "color": "#5eead4"
    }
}

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

400 — нарушена валидация:

JSON 
{
    "success": false,
    "error": {
        "code": "INVALID_PARAMS",
        "message": "name is required"
    }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS Не передан name или groupId, либо значение неверного типа
422 BITRIX_ERROR Битрикс24 вернул ошибку при создании эпика, например скрам-проекта с указанным groupId не существует
403 SCOPE_DENIED Ключу не хватает скоупа task
403 WRITE_BLOCKED_READONLY_KEY Ключ работает только на чтение
401 TOKEN_MISSING У ключа нет настроенных токенов

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

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

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

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