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

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

Описание метода SDK bizproc.activity.update

Метод bizproc.activity.update является частью официального Bitrix24 PHP SDK и предназначен для выполнения REST-запросов к порталу. This method allows to update activity fields. Method parameters are similar to bizproc.activity.add.

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

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

public function update(
      string                                 $code,
      ?string                                $handlerUrl,
      ?int                                   $b24AuthUserId,
      ?array                                 $localizedName,
      ?array                                 $localizedDescription,
      ?bool                                  $isUseSubscription,
      ?array                                 $properties,
      ?bool                                  $isUsePlacement,
      ?array                                 $returnProperties,
      ?Workflows\Common\WorkflowDocumentType $documentType,
      ?array                                 $limitationFilter
  ): Result

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

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

<?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.activity.update
    $code = "пример_значения";
    $handlerUrl = null;
    $b24AuthUserId = null;
    $localizedName = null;
    $localizedDescription = null;
    $isUseSubscription = null;
    $properties = null;
    $isUsePlacement = null;
    $returnProperties = null;
    $documentType = null;
    $limitationFilter = null;

    // Выполнение запроса через Scope getBizProcScope и сервис activity
    $result = $serviceBuilder->getBizProcScope()->activity()->update(
          $code,
          $handlerUrl,
          $b24AuthUserId,
          $localizedName,
          $localizedDescription,
          $isUseSubscription,
          $properties,
          $isUsePlacement,
          $returnProperties,
          $documentType,
          $limitationFilter
      );

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

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

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

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