Как использовать метод SDK bizproc.workflow.template.add в Битрикс24

Оптимизация производительности и безопасности — залог успешного проекта на 1С-Битрикс. Данный материал посвящен практическому применению «Как использовать метод SDK bizproc.workflow.template.add в Битрикс24». Мы подготовили подробный разбор принципов работы и развернутые примеры интеграции.

Описание метода SDK bizproc.workflow.template.add

Метод bizproc.workflow.template.add является частью официального Bitrix24 PHP SDK и предназначен для выполнения REST-запросов к порталу. Add a workflow template, requires administrator access permissions

Параметры и сигнатура метода

В рамках SDK метод объявлен в пространстве имен \Bitrix24\SDK\Services\Workflows\Template\Service\Template со следующей сигнатурой:

public function add(
      Workflows\Common\WorkflowDocumentType      $workflowDocumentType,
      string                                     $name,
      string                                     $description,
      Workflows\Common\WorkflowAutoExecutionType $workflowAutoExecutionType,
      string                                     $filename
  ): Result

Пример использования на PHP

Ниже представлен готовый практический пример интеграции с использованием Bitrix24 PHP SDK. Этот пример показывает, как правильно инициализировать сервис-билдер и вызвать метод add:

<?php
declare(strict_types=1);

use Bitrix24\SDK\Services\ServiceBuilderFactory;

// Инициализация официального Bitrix24 PHP SDK через входящий вебхук
$webhookUrl = 'https://your-portal.bitrix24.ru/rest/1/your-webhook-code/';
$serviceBuilder = ServiceBuilderFactory::createServiceBuilderFromWebhook($webhookUrl);

try {
    // Подготовка параметров для вызова метода bizproc.workflow.template.add
    $workflowDocumentType = new \Workflows\Common\WorkflowDocumentType();
    $name = "пример_значения";
    $description = "пример_значения";
    $workflowAutoExecutionType = new \Workflows\Common\WorkflowAutoExecutionType();
    $filename = "пример_значения";

    // Выполнение запроса через Scope getBizProcScope и сервис template
    $result = $serviceBuilder->getBizProcScope()->template()->add(
          $workflowDocumentType,
          $name,
          $description,
          $workflowAutoExecutionType,
          $filename
      );

    // Обработка полученных данных
    print_r($result->getResponseData()->getResult());

} catch (\Throwable $exception) {
    // Обработка исключений при интеграции
    echo "Ошибка при выполнении метода bizproc.workflow.template.add: " . $exception->getMessage();
}

Полезные ссылки

• Официальная REST API документация: https://training.bitrix24.com/rest_help/workflows/wirkflow_template/bizproc_workflow_template_add.php
• Репозиторий PHP SDK на GitHub: bitrix24-php-sdk