метод REST scope: bizproc

bizproc.task.complete

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

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

Описание

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

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

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

Параметры

TASK_ID integer обязательный

Идентификатор задания.

Получить идентификатор можно методом bizproc.task.list

STATUS integer обязательный

Целевой статус задания. Возможные значения:

  • 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
- для типа Файл (Диск) — идентификатор файла с Диска

Подробнее о работе с файлами в статье How to upload files

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"TASK_ID":1501,"STATUS":3,"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

Ответ

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_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 Некорректный тип задания. Такое задание нельзя выполнить через REST
ERROR_TASK_EXECUTION текст ошибки из задания В процессе выполнения задания случилась указанная ошибка

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.