Блог Горошко Андрея Bitrix24,PHP Добавить эпик в Скрам tasks.api.scrum.epic.add

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

При разработке и поддержке проектов на платформе 1С-Битрикс критически важно использовать современные стандарты D7 API. В этом руководстве мы детально изучим тему «Добавить эпик в Скрам tasks.api.scrum.epic.add», разберем архитектурные особенности и предоставим готовые к интеграции примеры кода.

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

> 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 (Webhook)
    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 (OAuth)
    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
  • JS
    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);
    }
  • PHP
    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();
    }
  • BX24.js
    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);
        }
    );
  • PHP CRest
    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"
}

Возвращаемые данные {#fields}

Название
тип
Описание
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"
}

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

КодОписаниеЗначение
0Access deniedНет доступа к скраму
0Epic not createdНе удалось создать эпик
0createdBy user not foundПользователь в поле «создатель» не найден
0modifiedBy user not foundПользователь в поле «последний изменивший» не найден
0Group is not foundНе указан параметр GROUP_ID или группы с таким ID не существует
0Name is not foundНе указан параметр NAME
  • [](./index)
  • [](./tasks-api-scrum-epic-update)
  • [](./tasks-api-scrum-epic-get)
  • [](./tasks-api-scrum-epic-list)
  • [](./tasks-api-scrum-epic-delete)
  • [](./tasks-api-scrum-epic-get-fields)

💡 Экспертное мнение и рекомендации

Практические рекомендации:

  • При написании кастомных компонентов для «Добавить эпик в Скрам tasks.api.scrum.epic.add» всегда разделяйте бизнес-логику и представление (шаблон).
  • Используйте отладку SQL-запросов через конструкцию $wpdb->last_query или стандартный трекер Битрикса, чтобы контролировать нагрузку.

Похожая задача в бизнесе?

Помогу автоматизировать процессы и внедрить ИИ

Меня зовут Андрей Горошко. Я Full-stack разработчик и эксперт по 1С-Битрикс. Настраиваю CRM Битрикс24, разрабатываю защищенные API и создаю умных ИИ-агентов для автоматизации рутины.

Related Post

Как использовать метод SDK crm.currency.localizations.fields в Битрикс24Как использовать метод SDK crm.currency.localizations.fields в Битрикс24

Эффективная интеграция и кастомизация функционала в Битрикс24 часто требует работы на уровне API. Сегодня мы подробно рассмотрим «Как использовать метод SDK crm.currency.localizations.fields в Битрикс24». Вы узнаете экспертные методики работы с

Как использовать метод SDK task.checklistitem.renew в Битрикс24Как использовать метод SDK task.checklistitem.renew в Битрикс24

При разработке и поддержке проектов на платформе 1С-Битрикс критически важно использовать современные стандарты D7 API. В этом руководстве мы детально изучим тему «Как использовать метод SDK task.checklistitem.renew в Битрикс24», разберем

Sozdanie Stranicy: Руководство разработчикаSozdanie Stranicy: Руководство разработчика

Каждый PHP-разработчик, работающий с экосистемой Bitrix Framework, должен глубоко понимать работу её ключевых компонентов. В этой статье мы проведем подробный аудит темы «Sozdanie Stranicy: Руководство разработчика», проанализируем лучшие практики и