Как использовать метод SDK entity.item.property.delete в Битрикс24

Каждый PHP-разработчик, работающий с экосистемой Bitrix Framework, должен глубоко понимать работу её ключевых компонентов. В этой статье мы проведем подробный аудит темы «Как использовать метод SDK entity.item.property.delete в Битрикс24», проанализируем лучшие практики и покажем, как правильно использовать entity.item.property.delete в реальных задачах.

Описание метода SDK entity.item.property.delete

Метод entity.item.property.delete является частью официального Bitrix24 PHP SDK и предназначен для выполнения REST-запросов к порталу. Delete an additional property of storage elements.

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

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

public function delete(
      string $entity,
      string $propertyCode
  ): Result

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

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

<?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 {
    // Подготовка параметров для вызова метода entity.item.property.delete
    $entity = "пример_значения";
    $propertyCode = "пример_значения";

    // Выполнение запроса через Scope getEntityScope и сервис property
    $result = $serviceBuilder->getEntityScope()->property()->delete(
          $entity,
          $propertyCode
      );

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

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

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

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