Создать или обновить задачу Скрама tasks.api.scrum.task.update

Scope: task

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

Метод создает или обновляет задачу Скрама. Вы сможете:

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

Задачу нужно создать методом tasks.task.add или обновить методом tasks.task.update. Привязка задачи к скраму указывается в параметре идентификатора группы GROUP_ID.

Получить идентификатор группы можно методом создания новой группы или методом получения списка групп. Группа является скрамом, если у нее заполнено поле SCRUM_MASTER_ID.

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

Название `тип`	Описание
id* `integer`	Идентификатор задачи
fields* `object`	Объект содержащий записи о задаче скрама (подробное описание приведено ниже) в виде структуры: `fields: { entityId: 'значение' storyPoints: 'значение', epicId: 'значение', sort: 'значение' }`

Параметр fields

Название `тип`	Описание
entityId `integer`	Идентификатор бэклога или спринта. Если значение не указано, Битрикс24 автоматически добавит задачу в бэклог Скрама, если он существует
storyPoints `string`	Стори Поинты — относительная оценка сложности задачи. Может иметь строковое значение
epicId `integer`	Идентификатор эпика
sort `integer`	Сортировка

Примеры кода

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":1,"fields":{"epicId":1,"storyPoints":"8","entityId":2}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/tasks.api.scrum.task.update

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":1,"fields":{"epicId":1,"storyPoints":"8","entityId":2},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/tasks.api.scrum.task.update

try
        {
        	const response = await $b24.callMethod(
        		'tasks.api.scrum.task.update',
        		{
        			id: 1,
        			fields: 
        			{
        				epicId: 1,
        				storyPoints: '8',
        				entityId: 2
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'tasks.api.scrum.task.update',
                    [
                        'id' => 1,
                        'fields' => [
                            'epicId'      => 1,
                            'storyPoints' => '8',
                            'entityId'    => 2
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Нужная вам логика обработки данных
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating scrum task: ' . $e->getMessage();
        }

BX24.callMethod(
            'tasks.api.scrum.task.update',
            {
                id: 1,
                fields: 
                {
                    epicId: 1,
                    storyPoints: '8',
                    entityId: 2
                }
            },
            function(res)
            {
                console.log(res);
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'tasks.api.scrum.task.update',
            [
                'id' => 1,
                'fields' => [
                    'epicId' => 1,
                    'storyPoints' => '8',
                    'entityId' => 2
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "status" : "success",
            "data" : true,
            "errors" : []
        }

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

Название `тип`	Описание
status `string`	Статус ответа. Возможные значения: `success` `error`
data `boolean`\|`null`	Возвращает: `true` — в случае успеха `null` — в случае ошибки
errors `array`	Массив ошибок

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

HTTP-статус: 400

{
            "error": 0,
            "error_description": "Task not found"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код	Описание	Значение
`0`	Epic not found	Эпик не найден
`0`	Task not found	Задача не найдена
`0`	Access denied	Доступ запрещен
`0`	Item not created	Задача не добавлена в скрам

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

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	Превышен лимит на интенсивность запросов
`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	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Обзор методов

Получить поля задачи Скрама по id

Создать или обновить задачу Скрама tasks.api.scrum.task.update

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

Параметр fieldsПараметр fields

Примеры кодаПримеры кода

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

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

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

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

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

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