метод REST scope: bizproc

bizproc.workflow.start

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

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

Описание

Метод 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']
  • Коммерческое предложение — ['crm', 'Bitrix\Crm\Integration\BizProc\Document\Quote', 'QUOTE_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 смарт-процесса, 1ID элемента смарт-процесса
  • Счет — ['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

Ответ

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",
}
Код Описание Значение
400 ERROR_WRONG_WORKFLOW_ID Empty TEMPLATE_ID
400 ERROR_WRONG_WORKFLOW_ID Template not found
400 Пустое значение Wrong DOCUMENT_ID!
400 Пустое значение Incorrect document type!
400 Пустое значение Template type and DOCUMENT_ID mismatch!
403 ACCESS_DENIED Access denied!

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

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