Запустить бизнес-процесс bizproc.workflow.start

Scope: bizproc

Кто может выполнять метод: администратор

Метод bizproc.workflow.start запускает новый бизнес-процесс.

Запустить бизнес-процесс используя REST можно только на платных тарифах, demo лицензиях и лицензиях NFR.

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

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

Название
тип

Описание

TEMPLATE_ID*
integer

Идентификатор шаблона бизнес-процесса

DOCUMENT_ID*
array

Идентификатор документа для запуска бизнес-процесса в формате [модуль, объект, ID_элемента].

Примеры записей для разных вариантов документов:

  • Лид — ['crm', 'CCrmDocumentLead', 'LEAD_777']
  • Компания — ['crm', 'CCrmDocumentCompany', 'COMPANY_777']
  • Контакт — ['crm', 'CCrmDocumentContact', 'CONTACT_777']
  • Сделка — ['crm', 'CCrmDocumentDeal', 'DEAL_777']
  • Файл диска — ['disk', 'Bitrix\\Disk\\BizProcDocument', '777']
  • Документ процессов в ленте новостей — ['lists', 'BizprocDocument', '777']
  • Документ списков — ['lists', 'Bitrix\\Lists\\BizprocDocumentLists', '777']
  • Элемент смарт-процесса — ['crm', 'Bitrix\\Crm\\Integration\\BizProc\\Document\\Dynamic', 'DYNAMIC_147_1'], где 147 — это ID смарт-процесса, 1 — ID элемента смарт-процесса
  • Счет — ['crm', 'Bitrix\\Crm\\Integration\\BizProc\\Document\\SmartInvoice', 'SMART_INVOICE_3']

PARAMETERS
object

Значения параметров шаблона бизнес-процесса.

Используется, если у шаблона есть параметры.

Для передачи значения в параметр типа «Привязка к пользователю» используйте запись вида user_ID. Например:

PARAMETERS: {
            'resp_employee': user_14 // ID сотрудника — 14
        }

Примеры кода

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"TEMPLATE_ID":1,"DOCUMENT_ID":["crm","CCrmDocumentLead","LEAD_1"],"PARAMETERS":{"Parameter1":"user_1"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/bizproc.workflow.start
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"TEMPLATE_ID":1,"DOCUMENT_ID":["crm","CCrmDocumentLead","LEAD_1"],"PARAMETERS":{"Parameter1":"user_1"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/bizproc.workflow.start
        
try
        {
        	const response = await $b24.callMethod(
        		'bizproc.workflow.start',
        		{
        			TEMPLATE_ID: 1,
        			DOCUMENT_ID: [
        				'crm',
        				'CCrmDocumentLead',
        				'LEAD_1'
        			],
        			PARAMETERS: {
        				'Parameter1': 'user_1'
        			},
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log('response', result.answer);
        	if (result.error())
        		alert("Error: " + result.error());
        	else
        		console.log(result);
        }
        catch( error )
        {
        	console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'bizproc.workflow.start',
                    [
                        'TEMPLATE_ID' => 1,
                        'DOCUMENT_ID' => [
                            'crm',
                            'CCrmDocumentLead',
                            'LEAD_1'
                        ],
                        'PARAMETERS' => [
                            'Parameter1' => 'user_1'
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Нужная вам логика обработки данных
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error starting workflow: ' . $e->getMessage();
        }
        
BX24.callMethod(	
            'bizproc.workflow.start',
            {
                TEMPLATE_ID: 1,
                DOCUMENT_ID: [
                    'crm',
                    'CCrmDocumentLead',
                    'LEAD_1'
                ],
                PARAMETERS: {
                    'Parameter1': 'user_1'
                },
            },
            function(result) {
                console.log('response', result.answer);
                if(result.error())
                    alert("Error: " + result.error());
                else
                console.log(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'bizproc.workflow.start',
            [
                'TEMPLATE_ID' => 1,
                'DOCUMENT_ID' => [
                    'crm',
                    'CCrmDocumentLead',
                    'LEAD_1'
                ],
                'PARAMETERS' => [
                    'Parameter1' => 'user_1'
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": "66e81a641752f8.56521481",
            "time": {
                "start": 1726476060.581428,
                "finish": 1726476060.813776,
                "duration": 0.23234796524047852,
                "processing": 0.002630949020385742,
                "date_start": "2024-09-16T08:41:00+00:00",
                "date_finish": "2024-09-16T08:41:00+00:00",
                "operating_reset_at": 1726476660,
                "operating": 0,
            },
        }

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

Название
тип

Описание

result
string

Корневой элемент ответа.

Возвращает идентификатор запущенного бизнес-процесса

time
time

Информация о времени выполнения запроса

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

HTTP-статус: 400

{
            "error": "ERROR_WRONG_WORKFLOW_ID",
            "error_description": "Empty TEMPLATE_ID",
        }

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Статус

Код

Описание

Значение

400

ERROR_WRONG_WORKFLOW_ID

Empty TEMPLATE_ID

Передали пустой входной параметр TEMPLATE_ID

400

ERROR_WRONG_WORKFLOW_ID

Template not found

Не был найден шаблон бизнес-процесса по переданному значению TEMPLATE_ID

400

Пустое значение

Wrong DOCUMENT_ID!

Передан неправильный DOCUMENT_ID

400

Пустое значение

Incorrect document type!

Не удалось определить тип документа по переданному DOCUMENT_ID

400

Пустое значение

Template type and DOCUMENT_ID mismatch!

Тип документа в шаблоне и вычисленный по DOCUMENT_ID тип документа не совпадают.

Попытка запустить шаблон не на той сущности, для которой он был создан

403

ACCESS_DENIED

Access denied!

Метод запустил не администратор

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

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

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

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

Предыдущая
Обзор
Следующая
Получить список бизнес-процессов