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

При разработке и поддержке проектов на платформе 1С-Битрикс критически важно использовать современные стандарты D7 API. В этом руководстве мы детально изучим тему «Как использовать метод SDK task.checklistitem.add в Битрикс24», разберем архитектурные особенности и предоставим готовые к интеграции примеры кода.

Описание метода SDK task.checklistitem.add

Метод task.checklistitem.add является частью официального Bitrix24 PHP SDK и предназначен для выполнения REST-запросов к порталу. Adds a new checklist item to the task

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

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

public function add(
      int $taskId,
      string $title,
      int $sort = 10,
      bool $completed = false
  ): 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 {
    // Подготовка параметров для вызова метода task.checklistitem.add
    $taskId = 123;
    $title = "пример_значения";
    $sort = 123;
    $completed = true;

    // Выполнение запроса через Scope getTaskScope и сервис task
    $result = $serviceBuilder->getTaskScope()->task()->add(
          $taskId,
          $title,
          $sort,
          $completed
      );

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

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

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

• Официальная REST API документация: https://apidocs.bitrix24.com/api-reference/tasks/checklist-item/task-checklist-item-add.html
• Репозиторий PHP SDK на GitHub: bitrix24-php-sdk