Получить список всех настраиваемых полей заданного шаблона реквизитов crm.requisite.preset.field.list

Scope: crm

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

Метод возвращает список всех настраиваемых полей для определенного шаблона реквизитов.

Параметры метода

Обязательные параметры отмечены *

Название `тип`	Описание
preset* `object`	Объект, содержащий значение идентификатора шаблона, из которого извлекается список настраиваемых полей (например, `{"ID": 27}`). Идентификаторы шаблонов можно получить с помощью метода crm.requisite.preset.list

Примеры кода

Как использовать примеры в документации

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"preset":{"ID":27}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.preset.field.list

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"preset":{"ID":27},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.requisite.preset.field.list

// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
        
        try {
          const response = await $b24.callListMethod(
            'crm.requisite.preset.field.list',
            {
              preset: {
                "ID": 27
              }
            }
          )
          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('crm.requisite.preset.field.list', {
            preset: {
              "ID": 27
            }
          }, '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('crm.requisite.preset.field.list', {
            preset: {
              "ID": 27
            }
          }, 0)
          const result = response.getData().result || []
          for (const entity of result) { console.log('Entity:', entity) }
        } catch (error) {
          console.error('Request failed', error)
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.requisite.preset.field.list',
                    [
                        'preset' => [
                            'ID' => 27
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching preset field list: ' . $e->getMessage();
        }

BX24.callMethod(
            "crm.requisite.preset.field.list",
            {
                preset:
                {
                    "ID": 27
                }
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.requisite.preset.field.list',
            [
                'preset' => ['ID' => 27]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Обработка ответа

HTTP-статус: 200

{
            "result": [
                {
                    "ID": 1,
                    "FIELD_NAME": "RQ_INN",
                    "FIELD_TITLE": "",
                    "IN_SHORT_LIST": "Y",
                    "SORT": 510
                },
                {
                    "ID": 2,
                    "FIELD_NAME": "RQ_COMPANY_NAME",
                    "FIELD_TITLE": "",
                    "IN_SHORT_LIST": "Y",
                    "SORT": 520
                },
                {
                    "ID": 3,
                    "FIELD_NAME": "RQ_COMPANY_FULL_NAME",
                    "FIELD_TITLE": "",
                    "IN_SHORT_LIST": "N",
                    "SORT": 530
                },
                {
                    "ID": 4,
                    "FIELD_NAME": "RQ_OGRN",
                    "FIELD_TITLE": "",
                    "IN_SHORT_LIST": "N",
                    "SORT": 540
                },
                {
                    "ID": 5,
                    "FIELD_NAME": "RQ_KPP",
                    "FIELD_TITLE": "",
                    "IN_SHORT_LIST": "Y",
                    "SORT": 550
                },
                {
                    "ID": 6,
                    "FIELD_NAME": "RQ_COMPANY_REG_DATE",
                    "FIELD_TITLE": "",
                    "IN_SHORT_LIST": "N",
                    "SORT": 560
                },
                {
                    "ID": 7,
                    "FIELD_NAME": "RQ_OKPO",
                    "FIELD_TITLE": "",
                    "IN_SHORT_LIST": "N",
                    "SORT": 570
                },
                {
                    "ID": 8,
                    "FIELD_NAME": "RQ_OKTMO",
                    "FIELD_TITLE": "",
                    "IN_SHORT_LIST": "N",
                    "SORT": 580
                },
                {
                    "ID": 9,
                    "FIELD_NAME": "RQ_DIRECTOR",
                    "FIELD_TITLE": "",
                    "IN_SHORT_LIST": "N",
                    "SORT": 590
                },
                {
                    "ID": 10,
                    "FIELD_NAME": "RQ_ACCOUNTANT",
                    "FIELD_TITLE": "",
                    "IN_SHORT_LIST": "N",
                    "SORT": 600
                },
                {
                    "ID": 11,
                    "FIELD_NAME": "RQ_ADDR",
                    "FIELD_TITLE": "",
                    "IN_SHORT_LIST": "N",
                    "SORT": 610
                },
                {
                    "ID": 12,
                    "FIELD_NAME": "RQ_SIGNATURE",
                    "FIELD_TITLE": "",
                    "IN_SHORT_LIST": "N",
                    "SORT": 620
                },
                {
                    "ID": 13,
                    "FIELD_NAME": "RQ_STAMP",
                    "FIELD_TITLE": "",
                    "IN_SHORT_LIST": "N",
                    "SORT": 630
                },
                {
                    "ID": 14,
                    "FIELD_NAME": "UF_CRM_1703689889",
                    "FIELD_TITLE": "",
                    "IN_SHORT_LIST": "Y",
                    "SORT": 640
                },
                {
                    "ID": 15,
                    "FIELD_NAME": "UF_CRM_1703690003",
                    "FIELD_TITLE": "",
                    "IN_SHORT_LIST": "Y",
                    "SORT": 650
                }
            ],
            "time": {
                "start": 1716895759.934609,
                "finish": 1716895760.407579,
                "duration": 0.47297000885009766,
                "processing": 0.023286104202270508,
                "date_start": "2024-05-28T13:29:19+02:00",
                "date_finish": "2024-05-28T13:29:20+02:00",
                "operating": 0
            }
        }

Возвращаемые данные

Название `тип`	Описание
result `array`	Массив объектов, описывающих настраиваемые поля шаблона реквизитов. Каждый элемент содержит поля настраиваемого поля шаблона
total `integer`	Общее количество найденных записей
time `time`	Информация о времени выполнения запроса

Поля, описывающие настраиваемое поле шаблона реквизитов

Название `тип`	Описание
ID `integer`	Идентификатор поля. Создается автоматически и уникален в рамках шаблона
FIELD_NAME `string`	Название поля
FIELD_TITLE `string`	Альтернативное название поля для реквизита. Альтернативное название отображается в различных формах для заполнения реквизитов. В зависимости от конкретной формы альтернативное название может использоваться или нет
SORT `integer`	Сортировка. Порядок в списке полей шаблона
IN_SHORT_LIST `char`	Показывать в кратком списке. Устаревшее поле, сейчас не используется. Оставлено для обратной совместимости. Может принимать значения `Y` или `N`

Обработка ошибок

HTTP-статус: 40x, 50x

{
            "error": "",
            "error_description": "The Preset with ID '27' is not found"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код	Описание
`The Preset with ID '27' is not found`	Шаблон с указанным идентификатором не найден
`Access denied`	Недостаточно прав доступа для получения списка настраиваемых полей шаблона

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Получить настраиваемое поле шаблона реквизитов по id

Удалить настраиваемое поле из шаблона реквизитов

Получить список всех настраиваемых полей заданного шаблона реквизитов crm.requisite.preset.field.list

Параметры методаПараметры метода

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

Возвращаемые данныеВозвращаемые данные

Поля, описывающие настраиваемое поле шаблона реквизитовПоля, описывающие настраиваемое поле шаблона реквизитов

Обработка ошибокОбработка ошибок

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение