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

Добавить бэклог в Скрам tasks.api.scrum.backlog.add

Оптимизация производительности и безопасности — залог успешного проекта на 1С-Битрикс. Данный материал посвящен практическому применению «Добавить бэклог в Скрам tasks.api.scrum.backlog.add». Мы подготовили подробный разбор принципов работы и развернутые примеры интеграции.

Добавить бэклог в Скрам tasks.api.scrum.backlog.add

> Scope: task
>
> Кто может выполнять метод: любой пользователь

Метод tasks.api.scrum.backlog.add добавляет бэклог в Скрам.

Может понадобиться, чтобы создать бэклог при импорте после создания Скрама.

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

Название
тип
Описание
fields
object
Объект содержащий записи о группе и пользователе (подробное описание приведено ниже) в виде структуры:

"fields": {
    "groupId": значение,
    "createdBy": значение,
    "modifiedBy": значение,
}    

Параметр fields

Название
тип
Описание
groupId
integer
Идентификатор группы, для которой создается бэклог.

Иденитификатор группы можно получить при создании новой группы sonet_group.create или при получении списка существующих групп socialnetwork-api-workgroup-list.md

createdBy*
integer
Идентификатор пользователя, от кого будет создан бэклог
modifiedBy
integer
Идентификатор пользователя, от кого будет модифицирован бэклог

Примеры кода

  • cURL (Webhook)
    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"fields": {"groupId": 1, "createdBy": 1}}' \
    https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webbhook_here**/tasks.api.scrum.backlog.add
  • cURL (OAuth)
    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"fields": {"groupId": 1, "createdBy": 1}, "auth":"**put_access_token_here**"}' \
    https://**put_your_bitrix24_address**/rest/tasks.api.scrum.backlog.add
  • JS
    try
    {
    	const response = await $b24.callMethod(
    		'tasks.api.scrum.backlog.add',
    		{
    			"fields": {
    				"groupId": 125,
    				"createdBy": 6,
    			},
    		}
    	);
    	
    	const result = response.getData().result;
    	console.info(result);
    }
    catch( error )
    {
    	console.error(error);
    }
  • PHP
    try {
        $response = $b24Service
            ->core
            ->call(
                'tasks.api.scrum.backlog.add',
                [
                    'fields' => [
                        'groupId'   => 125,
                        'createdBy' => 6,
                    ],
                ]
            );
    
        $result = $response
            ->getResponseData()
            ->getResult();
    
        if ($result->error()) {
            error_log($result->error());
            echo 'Error: ' . $result->error();
        } else {
            echo 'Success: ' . print_r($result->data(), true);
        }
    
    } catch (Throwable $e) {
        error_log($e->getMessage());
        echo 'Error adding backlog: ' . $e->getMessage();
    }
  • BX24.js
    BX24.callMethod(
        'tasks.api.scrum.backlog.add',{
            "fields": {
                "groupId": 125,
                "createdBy": 6,
            },
        },
        function(result) {
            if (result.error()) {
                console.error(result.error());
            } else {
                console.info(result.data());
            }
        }
    );
  • PHP CRest
    require_once('crest.php');

    $result = CRest::call(
    'tasks.api.scrum.backlog.add',
        [
            'fields' => [
                'groupId' => 1,
                'createdBy' => 1,
            ],
        ]
    );

    echo '<PRE>';
    print_r($result);
    echo '</PRE>';

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

HTTP-статус: 200

{
    "result": {
        "id": 1,
        "groupId": 125,
        "createdBy": 6,
        "modifiedBy": 0
    },
    "time":{
        "start":1712137817.343984,
        "finish":1712137817.605804,
        "duration":0.26182007789611816,
        "processing":0.018325090408325195,
        "date_start":"2024-04-03T12:50:17+03:00",
        "date_finish":"2024-04-03T12:50:17+03:00"
    }
}

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

Название
тип
Описание
id
integer
Идентификатор бэклога
groupId
integer
Идентификатор группы, для которой был создан бэклог
createdBy
integer
Идентификатор пользователя, который создал бэклог
modifiedBy
integer
Идентификатор пользователя, который изменил бэклог

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

HTTP-статус: 400

{
    "error":0,
    "error_description":"Access denied"
}

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

КодCообщение об ошибкеОписание
0Backlog already addedОшибка возникает при попытке создания бэклога, при этом в группе уже сущеcтвует активный бэклог
0Access deniedОтсутствуют соответствующие права доступа
0createdBy user not foundПереданный индентификатор пользователя невалидный. Например, пользователя с таким идентификатором не существует
0modifiedBy user not foundПереданный индентификатор пользователя невалидный. Например, пользователя с таким идентификатором не существует
0Unknown errorДругая ошибка
  • [](./tasks-api-scrum-backlog-update)
  • [](./tasks-api-scrum-backlog-get)
  • [](./tasks-api-scrum-backlog-delete)
  • [](./tasks-api-scrum-backlog-get-fields)

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

Ключевые выводы по теме «Добавить бэклог в Скрам tasks.api.scrum.backlog.add»:

Использование современных стандартов D7 при работе с tasks.api.scrum.backlog.add позволяет писать чистый, масштабируемый и безопасный код. Не забывайте обрабатывать исключения (try/catch) и проверять права доступа текущего пользователя перед выполнением критических операций.

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

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

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

Related Post

Получить свойство отгрузки sale.shipmentproperty.getПолучить свойство отгрузки sale.shipmentproperty.get

Оптимизация производительности и безопасности — залог успешного проекта на 1С-Битрикс. Данный материал посвящен практическому применению «Получить свойство отгрузки sale.shipmentproperty.get». Мы подготовили подробный разбор принципов работы и развернутые примеры интеграции. Получить

Получить список лог-записей таймлана crm.timeline.logmessage.listПолучить список лог-записей таймлана crm.timeline.logmessage.list

Оптимизация производительности и безопасности — залог успешного проекта на 1С-Битрикс. Данный материал посвящен практическому применению «Получить список лог-записей таймлана crm.timeline.logmessage.list». Мы подготовили подробный разбор принципов работы и развернутые примеры интеграции.

Получить список полей товаров документа складского учета catalog.document.ele…Получить список полей товаров документа складского учета catalog.document.ele…

Эффективная интеграция и кастомизация функционала в Битрикс24 часто требует работы на уровне API. Сегодня мы подробно рассмотрим «Получить список полей товаров документа складского учета catalog.document.ele…». Вы узнаете экспертные методики работы