Блог Горошко Андрея Bitrix24,PHP Получить описание настраиваемых полей шаблона реквизитов crm.requisite.preset…

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

При разработке и поддержке проектов на платформе 1С-Битрикс критически важно использовать современные стандарты D7 API. В этом руководстве мы детально изучим тему «Получить описание настраиваемых полей шаблона реквизитов crm.requisite.preset…», разберем архитектурные особенности и предоставим готовые к интеграции примеры кода.

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

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

Метод возвращает формально описание полей, описывающих настаиваемое поле шаблона реквизитов.

Без параметров.

Примеры кода

  • cURL (Webhook)
    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{}' \
    https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.preset.field.fields
  • cURL (OAuth)
    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"auth":"**put_access_token_here**"}' \
    https://**put_your_bitrix24_address**/rest/crm.requisite.preset.field.fields
  • JS
    try
    {
    	const response = await $b24.callMethod(
    		'crm.requisite.preset.field.fields',
    		{}
    	);
    	
    	const result = response.getData().result;
    	console.dir(result);
    }
    catch( error )
    {
    	console.error('Error:', error);
    }
  • PHP
    try {
        $response = $b24Service
            ->core
            ->call(
                'crm.requisite.preset.field.fields',
                []
            );
    
        $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 fields: ' . $e->getMessage();
    }
  • BX24.js
    BX24.callMethod(
        "crm.requisite.preset.field.fields",
        {},
        function(result)
        {
            if(result.error())
                console.error(result.error());
            else
                console.dir(result.data());
        }
    );
  • PHP CRest
    require_once('crest.php');

    $result = CRest::call(
        'crm.requisite.preset.field.fields',
        []
    );

    echo '<PRE>';
    print_r($result);
    echo '</PRE>';

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

HTTP-статус: 200

{
    "result": {
        "ID": {
            "type": "integer",
            "isRequired": false,
            "isReadOnly": true,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "ID"
        },
        "FIELD_NAME": {
            "type": "string",
            "isRequired": true,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Имя"
        },
        "FIELD_TITLE": {
            "type": "string",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Название в шаблоне"
        },
        "SORT": {
            "type": "integer",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Сортировка"
        },
        "IN_SHORT_LIST": {
            "type": "char",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Показывать в кратком списке"
        }
    },
    "time": {
        "start": 1716823643.597269,
        "finish": 1716823643.949143,
        "duration": 0.35187387466430664,
        "processing": 0.012942075729370117,
        "date_start": "2024-05-27T17:27:23+02:00",
        "date_finish": "2024-05-27T17:27:23+02:00",
        "operating": 0
    }
}

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

Название
тип
Описание
result
object
Объект в формате {"field_1": "value_1", ... "field_N": "value_N"}, где field — идентификатор поля, а value — объект с атрибутами поля
time
time
Информация о времени выполнения запроса

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

Название
тип
Описание
ID
integer
Идентификатор поля. Создается автоматически и уникален в рамках шаблона
FIELD_NAME
string
Название поля
FIELD_TITLE
string
Альтернативное название поля для реквизита.

Альтернативное название отображается в различных формах для заполнения реквизитов. В зависимости от конкретной формы альтернативное название может использоваться или нет

SORT
integer
Сортировка. Порядок в списке полей шаблона
IN_SHORT_LIST
char
Показывать в кратком списке. Устаревшее поле, сейчас не используется. Оставлено для обратной совместимости. Может принимать значения Y или N

Описание атрибутов {#attribute}

Название
тип
Описание
type
string
Тип поля
isRequired
boolean
Атрибут «обязательное». Возможные значения:
— true — да
— false — нет
isReadOnly
boolean
Атрибут «только для чтения». Возможные значения:
— true — да
— false — нет
isImmutable
boolean
Атрибут «неизменяемое». Возможные значения:
— true — да
— false — нет
isMultiple
boolean
Атрибут «мультиполе». Возможные значения:
— true — да
— false — нет
isDynamic
boolean
Атрибут «пользовательское». Возможные значения:
— true — да
— false — нет
title
string
Идентификатор поля

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

  • [](./crm-requisite-preset-field-add)
  • [](./crm-requisite-preset-field-update)
  • [](./crm-requisite-preset-field-available-to-add)
  • [](./crm-requisite-preset-field-get)
  • [](./crm-requisite-preset-field-list)
  • [](./crm-requisite-preset-field-delete)

💡 Экспертное мнение и рекомендации

Советы эксперта по интеграции:

  • Всегда используйте кэширование при частых запросах к crm.requisite.preset.field.fields, чтобы разгрузить базу данных.
  • Соблюдайте стандарты PSR при написании обработчиков для «Получить описание настраиваемых полей шаблона реквизитов crm.requisite.preset…».
  • Регулярно проводите аудит производительности системы с помощью встроенного монитора 1С-Битрикс.

Похожая задача в бизнесе?

Помогу автоматизировать процессы и внедрить ИИ

Меня зовут Андрей Горошко. Я Full-stack разработчик и эксперт по 1С-Битрикс. Настраиваю CRM Битрикс24, разрабатываю защищенные API и создаю умных ИИ-агентов для автоматизации рутины.

Related Post

Найти пользователей im.search.user.listНайти пользователей im.search.user.list

При разработке и поддержке проектов на платформе 1С-Битрикс критически важно использовать современные стандарты D7 API. В этом руководстве мы детально изучим тему «Найти пользователей im.search.user.list», разберем архитектурные особенности и предоставим

Получить список типов плательщиков crm.persontype.listПолучить список типов плательщиков crm.persontype.list

Оптимизация производительности и безопасности — залог успешного проекта на 1С-Битрикс. Данный материал посвящен практическому применению «Получить список типов плательщиков crm.persontype.list». Мы подготовили подробный разбор принципов работы и развернутые примеры интеграции.

Изменить пользовательское поле crm.invoice.userfield.updateИзменить пользовательское поле crm.invoice.userfield.update

При разработке и поддержке проектов на платформе 1С-Битрикс критически важно использовать современные стандарты D7 API. В этом руководстве мы детально изучим тему «Изменить пользовательское поле crm.invoice.userfield.update», разберем архитектурные особенности и