Блог Горошко Андрея Bitrix24,PHP Запустить бизнес-процесс bizproc.workflow.start

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

При разработке и поддержке проектов на платформе 1С-Битрикс критически важно использовать современные стандарты D7 API. В этом руководстве мы детально изучим тему «Запустить бизнес-процесс bizproc.workflow.start», разберем архитектурные особенности и предоставим готовые к интеграции примеры кода.

Запустить бизнес-процесс 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 (Webhook)
    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_webbhook_here**/bizproc.workflow.start
  • cURL (OAuth)
    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
  • JS
    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);
    }
  • PHP
    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.js
    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());
        }
    );
  • PHP CRest
    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",
}

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

СтатусКодОписаниеЗначение
400ERROR_WRONG_WORKFLOW_IDEmpty TEMPLATE_IDПередали пустой входной параметр TEMPLATE_ID
400ERROR_WRONG_WORKFLOW_IDTemplate 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 тип документа не совпадают.

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

403ACCESS_DENIEDAccess denied!Метод запустил не администратор
  • [](./index)
  • [](./bizproc-workflow-instances)
  • [](./bizproc-workflow-terminate)
  • [](./bizproc-workflow-kill)

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

Советы эксперта по интеграции:

  • Всегда используйте кэширование при частых запросах к bizproc.workflow.start, чтобы разгрузить базу данных.
  • Соблюдайте стандарты PSR при написании обработчиков для «Запустить бизнес-процесс bizproc.workflow.start».
  • Регулярно проводите аудит производительности системы с помощью встроенного монитора 1С-Битрикс.

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

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

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

Related Post

Интеграция B2B-портала с 1С:ERP и 1С:Комплексная автоматизацияИнтеграция B2B-портала с 1С:ERP и 1С:Комплексная автоматизация

Создание и развитие эффективного веб-ресурса по направлению «Интеграция B2B-портала с 1С:ERP и 1С:Комплексная автоматизация» позволяет усилить позиции бренда на рынке, автоматизировать взаимодействие с заказчиками и кратно увеличить поток входящих обращений.

Получить текущую выбранную линию в качестве исходящей линии по умолчанию voxi…Получить текущую выбранную линию в качестве исходящей линии по умолчанию voxi…

При разработке и поддержке проектов на платформе 1С-Битрикс критически важно использовать современные стандарты D7 API. В этом руководстве мы детально изучим тему «Получить текущую выбранную линию в качестве исходящей линии

Получить информацию о контексте вызова BX24.placement.infoПолучить информацию о контексте вызова BX24.placement.info

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