Добавить эпик в Скрам tasks.api.scrum.epic.add

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: task

Кто может выполнять метод: любой пользователь, имеющий доступ к Скраму

Метод добавляет эпик в Скрам.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

fields*
object

Значения полей (подробное описание приведено ниже) для добавления нового эпика в виде структуры:

fields: {
            name: 'значение',
            groupId: 'значение',
            description: 'значение',
            color: 'значение',
            files: [
                'файл1',
                'файл2',
                ...
            ]
        
        }

Параметр fields

Обязательные параметры отмечены *

Название
тип

Описание

name*
string

Название эпика

description
string

Описание эпика

groupId*
integer

Идентификатор группы (скрама), к которой относится эпик

color
string

Цвет эпика

files
array

Массив файлов, привязанных к эпику.

В files можно передать массив значений с идентификаторами файлов, указав префикс n для каждого идентификатора

createdBy
integer

Кем создан

modifiedBy
integer

Кем изменен

Примеры кода

Как использовать примеры в документации

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" \
        -H "Authorization: YOUR_ACCESS_TOKEN" \
        -d '{
        "fields": {
            "name": "Epic 1",
            "groupId": 1,
            "description": "Description text",
            "color": "#69dafc",
            "files": ["n428", "n345"]
        }
        }' \
        https://your-domain.bitrix24.com/rest/tasks.api.scrum.epic.add
        
try
        {
        	const response = await $b24.callMethod(
        		'tasks.api.scrum.epic.add',
        		{
        			fields: {
        				name: name,
        				groupId: groupId,
        				description: description,
        				color: color,
        				files: files
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	console.error('Error:', 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']);
        }

Обработка ответа

HTTP-Статус: 200

{
            "id": 4,
            "groupId": 1,
            "name": "Epic 1",
            "description": "Description text",
            "createdBy": 1,
            "modifiedBy": 1,
            "color": "#69dafc"
        }

Возвращаемые данные

Название
тип

Описание

id
integer

Идентификатор эпика

groupId
integer

Идентификатор группы (скрама), к которой привязан эпик

name
string

Название эпика

description
string

Описание эпика

createdBy
integer

Идентификатор пользователя, создавшего эпик

modifiedBy
integer

Идентификатор пользователя, который последним изменял эпик

color
string

Цвет эпика в формате HEX

Обработка ошибок

HTTP-статус: 400

{
            "error": 0,
            "error_description": "Group is not found"
        }

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Описание

Значение

0

Access denied

Нет доступа к скраму

0

Epic not created

Не удалось создать эпик

0

createdBy user not found

Пользователь в поле «создатель» не найден

0

modifiedBy user not found

Пользователь в поле «последний изменивший» не найден

0

Group is not found

Не указан параметр GROUP_ID или группы с таким ID не существует

0

Name is not found

Не указан параметр NAME

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Обзор методов
Следующая
Обновить эпик в Скраме