Эффективная интеграция и кастомизация функционала в Битрикс24 часто требует работы на уровне API. Сегодня мы подробно рассмотрим «Получить список пользовательских полей task.item.userfield.getlist». Вы узнаете экспертные методики работы с task.item.userfield.getlist и научитесь избегать типичных ошибок начинающих разработчиков.

Получить список пользовательских полей task.item.userfield.getlist

• не указаны типы параметров
• не указана обязательность параметров
• не хватает 1 примера (должно быть три примера — curl, js, php)
• отсутствует ответ в случае ошибки
• отсутствует ответ в случае успеха

Тут может не хватать некоторых данных — дополним в ближайшее время

> Scope: task
>
> Кто может выполнять метод: любой пользователь

Метод task.item.userfield.getlist возвращает список свойств.

Входящие параметры и конфигурация метода

Практические примеры использования в коде

• JS

    // callListMethod рекомендуется использовать, когда необходимо получить весь набор списочных данных и объём записей относительно невелик (до примерно 1000 элементов). Метод загружает все данные сразу, что может привести к высокой нагрузке на память при работе с большими объемами.
    
    try {
      const response = await $b24.callListMethod(
        'task.item.userfield.getlist',
        {
          order: { "ID": "ASC" },
          filter: { "EDIT_IN_LIST": "Y" }
        },
        (progress) => { console.log('Progress:', progress) }
      )
      const items = response.getData() || []
      for (const entity of items) { console.log('Entity:', entity) }
    } catch (error) {
      console.error('Request failed', error)
    }
    
    // fetchListMethod предпочтителен при работе с крупными наборами данных. Метод реализует итеративную выборку с использованием генератора, что позволяет обрабатывать данные по частям и эффективно использовать память.
    
    try {
      const generator = $b24.fetchListMethod('task.item.userfield.getlist', { order: { "ID": "ASC" }, filter: { "EDIT_IN_LIST": "Y" } }, 'ID')
      for await (const page of generator) {
        for (const entity of page) { console.log('Entity:', entity) }
      }
    } catch (error) {
      console.error('Request failed', error)
    }
    
    // callMethod предоставляет ручной контроль над процессом постраничного получения данных через параметр start. Подходит для сценариев, где требуется точное управление пакетами запросов. Однако при больших объемах данных может быть менее эффективным по сравнению с fetchListMethod.
    
    try {
      const response = await $b24.callMethod('task.item.userfield.getlist', { order: { "ID": "ASC" }, filter: { "EDIT_IN_LIST": "Y" } }, 0)
      const result = response.getData().result || []
      for (const entity of result) { console.log('Entity:', entity) }
    } catch (error) {
      console.error('Request failed', error)
    }

• PHP

    try {
        $response = $b24Service
            ->core
            ->call(
                'task.item.userfield.getlist',
                [
                    'order' => [
                        'ID' => 'ASC'
                    ],
                    'filter' => [
                        'EDIT_IN_LIST' => 'Y'
                    ]
                ]
            );
    
        $result = $response
            ->getResponseData()
            ->getResult();
    
        // Нужная вам логика обработки данных
    
    } catch (Throwable $e) {
        error_log($e->getMessage());
        echo 'Error getting user fields list: ' . $e->getMessage();
    }

• BX24.js

    BX24.callMethod(
        "task.item.userfield.getlist",
        {
            order:
            {
                "ID": "ASC"
            },
            filter:
            {
                "EDIT_IN_LIST": "Y"
            }
        },
        function(result)
        {
        }
    );

• cURL

    $appParams = array(
    'auth' => 'q21g8vhcqmxdrbhqlbd2wh6ev1debppa',
    'ORDER' => array('ID' => 'asc'),
    'FILTER' => array('USER_TYPE_ID' => 'string')
    );

    $request = 'http://your-domain.ru/rest/task.item.userfield.getlist.xml?' . http_build_query($appParams);