Добавить эпик в Скрам tasks.api.scrum.epic.add
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
taskКто может выполнять метод: любой пользователь, имеющий доступ к Скраму
Метод добавляет эпик в Скрам.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
fields* |
Значения полей нового эпика (подробное описание) в виде структуры:
|
Параметр fields
Обязательные параметры отмечены *
|
Название |
Описание |
|
name* |
Название эпика, до 255 символов |
|
description |
Описание эпика |
|
groupId* |
Идентификатор Скрама, в котором создается эпик. Получить идентификатор можно методом socialnetwork.api.workgroup.list |
|
color |
Цвет эпика, например |
|
files |
Массив идентификаторов файлов Диска. Перед каждым идентификатором укажите префикс |
|
createdBy |
Идентификатор пользователя, который будет указан создателем эпика. По умолчанию — текущий пользователь |
Внимание
Идентификатор файла без префикса n и несуществующий файл метод пропускает без ошибки: эпик создается без этих файлов
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"fields": {
"name": "Epic 1",
"groupId": 1,
"description": "Description text",
"color": "#69dafc",
"files": ["n428", "n345"]
}
}' \
https://your-domain.bitrix24.com/rest/_USER_ID_/_CODE_/tasks.api.scrum.epic.add
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"fields": {
"name": "Epic 1",
"groupId": 1,
"description": "Description text",
"color": "#69dafc",
"files": ["n428", "n345"]
},
"auth": "YOUR_ACCESS_TOKEN"
}' \
https://your-domain.bitrix24.com/rest/tasks.api.scrum.epic.add
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type EpicAddResult = {
id: number
groupId: number
name: string
description: string
createdBy: number
modifiedBy: number
color: string
}
try {
const response = await $b24.actions.v2.call.make<EpicAddResult>({
method: 'tasks.api.scrum.epic.add',
params: {
fields: {
name: 'Epic 1',
groupId: 1,
description: 'Description text',
color: '#69dafc',
files: ['n428', 'n345'],
},
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Added epic:', result.id, result.name)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function addEpic() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'tasks.api.scrum.epic.add',
params: {
fields: {
name: 'Epic 1',
groupId: 1,
description: 'Description text',
color: '#69dafc',
files: ['n428', 'n345'],
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Added epic:', result.id, result.name)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addEpic)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.tasks.api.scrum.epic.add(
fields={
"name": "Epic 1",
"groupId": 1,
"description": "Description text",
"color": "#69dafc",
"files": [
"n428",
"n345",
],
},
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'tasks.api.scrum.epic.add',
[
'fields' => [
'name' => $name,
'groupId' => $groupId,
'description' => $description,
'color' => $color,
'files' => $files,
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Нужная вам логика обработки данных
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding epic: ' . $e->getMessage();
}
const groupId = 1;
const name = 'Epic 1';
const description = 'Description text';
const color = '#69dafc';
const files = ['n428', 'n345'];
BX24.callMethod(
'tasks.api.scrum.epic.add',
{
fields: {
name: name,
groupId: groupId,
description: description,
color: color,
files: files
}
},
function(res)
{
console.log(res);
}
);
require_once('crest.php'); // подключение CRest PHP SDK
$groupId = 1;
$name = 'Epic 1';
$description = 'Description text';
$color = '#69dafc';
$files = ['n428', 'n345'];
// выполнение запроса к REST API
$result = CRest::call(
'tasks.api.scrum.epic.add',
[
'fields' => [
'name' => $name,
'groupId' => $groupId,
'description' => $description,
'color' => $color,
'files' => $files
]
]
);
// Обработка ответа от Битрикс24
if (isset($result['error'])) {
echo 'Error: '.$result['error_description'];
}
else {
print_r($result['result']);
}
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "tasks.api.scrum.epic.add", b24.Params{
"fields": b24.Params{
"name": "Epic 1",
"groupId": 1,
"description": "Description text",
"color": "#69dafc",
"files": []string{"n428", "n345"},
},
})
if err != nil {
return fmt.Errorf("tasks.api.scrum.epic.add: %w", err)
}
// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.Result)
Обработка ответа
HTTP-статус: 200
{
"result": {
"id": 4,
"groupId": 1,
"name": "Epic 1",
"description": "Description text",
"createdBy": 1,
"modifiedBy": 0,
"color": "#69dafc"
},
"time": {
"start": 1790262925,
"finish": 1790262925.771081,
"duration": 0.7710809707641602,
"processing": 0,
"date_start": "2026-09-24T18:15:25+03:00",
"date_finish": "2026-09-24T18:15:25+03:00",
"operating_reset_at": 1790263525,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Данные созданного эпика (подробное описание) |
|
time |
Информация о времени выполнения запроса |
Объект result
|
Название |
Описание |
|
id |
Идентификатор эпика |
|
groupId |
Идентификатор Скрама, к которому относится эпик |
|
name |
Название эпика |
|
description |
Описание эпика. Если описание не передано — пустая строка |
|
createdBy |
Идентификатор пользователя, создавшего эпик |
|
modifiedBy |
Идентификатор пользователя, который последним изменил эпик. У нового эпика — |
|
color |
Цвет эпика. Если цвет не передан — пустая строка |
Прикрепленные файлы метод не возвращает. Получить их можно методом tasks.api.scrum.epic.get.
Обработка ошибок
HTTP-статус: 400
{
"error": "0",
"error_description": "Group id not found"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
Group id not found |
Не передан |
|
|
|
Name not found |
Не передано название |
|
|
|
Access denied |
У пользователя нет доступа к задачам группы или группы с таким |
|
|
|
createdBy user not found |
Пользователя из |
|
|
|
Epic not created |
Не удалось сохранить эпик, например название длиннее 255 символов или цвет длиннее 18 символов |
|
|
|
Epic files not attached |
Эпик создан, но файлы прикрепить не удалось |
|
|
|
Could not find value for parameter |
Не передан параметр |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Эпики в Скраме: обзор методов
- Обновить эпик в Скраме tasks.api.scrum.epic.update
- Получить поля эпика по его идентификатору tasks.api.scrum.epic.get
- Получить список эпиков tasks.api.scrum.epic.list
- Удалить эпик tasks.api.scrum.epic.delete
- Получить список доступных полей эпика tasks.api.scrum.epic.getFields