Выполнить задание бизнес-процесса bizproc.task.complete

Scope: bizproc

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

Метод выполняет задание бизнес-процесса:

Утверждение документа
Ознакомление с документом
Запрос дополнительной информации
Запрос дополнительной информации с отклонением

Выполнить можно только свое задание.

Пользовательская документация

Действия: Задания

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

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

Название `тип`	Описание
TASK_ID* `integer`	Идентификатор задания. Получить идентификатор можно методом bizproc.task.list
STATUS* `integer` \| `string`	Целевой статус задания. Возможные значения: `1` или `yes` — да, утвержден `2` или `no` — нет, отклонен `3` или `ok` — ок, ознакомлен `4` или `cancel` — отмена Набор допустимых значений меняется в зависимости от типа задания: Утверждение документа — `1` или `2` Ознакомление с документом — `3` Запрос дополнительной информации — `3` Запрос дополнительной информации с отклонением — `3` или `4`
COMMENT `string`	Комментарий пользователя. Обязательность параметра зависит от настроек задания
FIELDS `object`	Объект с описанием полей для выполнения заданий с запросом дополнительной информации в формате `{"field_1": "value_1", ... "field_N": "value_N"}`, где `field_N` — символьный идентификатор поля задания `value_N` — значение поля Получить описания полей в задании можно методом bizproc.task.list в объекте `"PARAMETERS": "Fields"` ответа. Структура описания объекта поля: `"PARAMETERS": { ... "Fields": [ { "Id": "field_id", "Type": "type", "Name": "name", "Description": "description", "Multiple": false, "Required": true, "Options": null, "Settings": null, "Default": "default_value" }` `Id` — символьный идентификатор поля задания. В `Default` хранятся значения по умолчанию, которые можно передать для выполнения задания. Эти значения сконвертированы во внешнее представление: для дат — в формат rest ATOM ISO-8601 для файлов — в ссылку на файл В таком формате значения передаются в метод `bizproc.task.complete`. Затем они конвертируются во внутреннее представление: даты из rest формата конвертируются во внутренний файлы сохраняются и прикрепляются к бизнес-процессу Чтобы передать значение в поле типа Файл укажите: для типа Файл — base64 или массив с названием и base64 для типа Файл (Диск) — идентификатор файла с Диска Подробнее о работе с файлами в статье Как загрузить файлы

Пример кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"TASK_ID":1501,"STATUS":1,"COMMENT":"Добавлено","Fields":{"contractor":"C_607","phone_number":"89991234567"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/bizproc.task.complete

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"TASK_ID":1501,"STATUS":1,"COMMENT":"Добавлено","Fields":{"contractor":"C_607","phone_number":"89991234567"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/bizproc.task.complete

try
        {
        	const response = await $b24.callMethod(
        		'bizproc.task.complete',
        		{
        			'TASK_ID': 1501,
        			'STATUS': 1,
        			'COMMENT': 'Добавлено',
        			"Fields": {
        				'contractor': 'C_607',
        				'phone_number': '89991234567'
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	alert("Error: " + error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'bizproc.task.complete',
                    [
                        'TASK_ID' => 1501,
                        'STATUS' => 1,
                        'COMMENT' => 'Добавлено',
                        'Fields' => [
                            'contractor' => 'C_607',
                            'phone_number' => '89991234567'
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error completing task: ' . $e->getMessage();
        }

BX24.callMethod(
            'bizproc.task.complete',
            {
                'TASK_ID': 1501,
                'STATUS': 1,
                'COMMENT': 'Добавлено',
                "Fields": {
                    'contractor': 'C_607',
                    'phone_number': '89991234567'
                }
            },
            function(result)
            {
                if(result.error())
                    alert("Error: " + result.error());
                else
                    console.log(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'bizproc.task.complete',
            [
                'TASK_ID' => 1501,
                'STATUS' => 1,
                'COMMENT' => 'Добавлено',
                'Fields' => [
                    'contractor' => 'C_607',
                    'phone_number' => '89991234567'
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": true,
            "time": {
                "start": 1738746693.9218969,
                "finish": 1738746694.1367991,
                "duration": 0.21490216255187988,
                "processing": 0.19237995147705078,
                "date_start": "2025-02-05T12:11:33+03:00",
                "date_finish": "2025-02-05T12:11:34+03:00",
                "operating_reset_at": 1738747293,
                "operating": 0.19236207008361816
            }
        }

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

Название `тип`	Описание
result `boolean`	Возвращает `true`, если задание выполнено успешно
time `time`	Информация о времени выполнения запроса

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

HTTP-статус: 400

{
            "error": "ERROR_TASK_VALIDATION",
            "error_description": "incorrect STATUS"
        }

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

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

Код	Сообщение об ошибке	Описание
`ERROR_TASK_VALIDATION`	empty TASK_ID	Не укзан `ID` задания
`ERROR_TASK_VALIDATION`	incorrect STATUS	Указан некорректный статус задания
`ERROR_TASK_NOT_FOUND`	Task not found	Не найдено задание с заданным `ID`
`ERROR_TASK_COMPLETED`	Task already completed	Задание уже выполнено ранее
`ERROR_TASK_TYPE`	Incorrect task type	Некорректный тип задания. Такое задание нельзя выполнить через рест
`ERROR_TASK_EXECUTION`	текст ошибки из задания	В процессе выполнения задания случилась указанная ошибка

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

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

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

Получить список заданий

Делегировать задание бизнес-процесса

Выполнить задание бизнес-процесса bizproc.task.complete

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

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

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

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

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

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

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

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