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

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

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

Получить описание полей шаблона реквизитов crm.requisite.preset.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_webbhook_here**/crm.requisite.preset.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.fields
  • JS
    try
    {
    	const response = await $b24.callMethod(
    		"crm.requisite.preset.fields",
    		{}
    	);
    	
    	const result = response.getData().result;
    	if(result.error())
    	{
    		console.error(result.error());
    	}
    	else
    	{
    		console.dir(result);
    	}
    }
    catch(error)
    {
    	console.error('Error:', error);
    }
  • PHP
    try {
        $response = $b24Service
            ->core
            ->call(
                'crm.requisite.preset.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 requisite preset fields: ' . $e->getMessage();
    }
  • BX24.js
    BX24.callMethod(
        "crm.requisite.preset.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.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"
        },
        "ENTITY_TYPE_ID": {
            "type": "integer",
            "isRequired": true,
            "isReadOnly": false,
            "isImmutable": true,
            "isMultiple": false,
            "isDynamic": false,
            "title": "ID типа объекта"
        },
        "COUNTRY_ID": {
            "type": "integer",
            "isRequired": true,
            "isReadOnly": false,
            "isImmutable": true,
            "isMultiple": false,
            "isDynamic": false,
            "title": "ID страны"
        },
        "NAME": {
            "type": "string",
            "isRequired": true,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Название"
        },
        "DATE_CREATE": {
            "type": "datetime",
            "isRequired": false,
            "isReadOnly": true,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Дата создания"
        },
        "DATE_MODIFY": {
            "type": "datetime",
            "isRequired": false,
            "isReadOnly": true,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Дата изменения"
        },
        "CREATED_BY_ID": {
            "type": "user",
            "isRequired": false,
            "isReadOnly": true,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Создал"
        },
        "MODIFY_BY_ID": {
            "type": "user",
            "isRequired": false,
            "isReadOnly": true,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Изменил"
        },
        "ACTIVE": {
            "type": "char",
            "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": "Сортировка"
        },
        "XML_ID": {
            "type": "string",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Внешний код"
        }
    },
    "time": {
        "start": 1716555914.663808,
        "finish": 1716555914.996533,
        "duration": 0.33272480964660645,
        "processing": 0.008843183517456055,
        "date_start": "2024-05-24T15:05:14+02:00",
        "date_finish": "2024-05-24T15:05:14+02:00",
        "operating": 0
    }
}

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

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

Описание полей шаблона реквизитов

Название
тип
Описание
ID
integer
Идентификатор реквизита. Создается автоматически и уникален в рамках портала
ENTITY_TYPE_ID
integer
Идентификатор типа родительского объекта. Сейчас это только «Реквизит» (идентификатор 8).

Идентификаторы типов объектов CRM отдает метод crm.enum.ownertype

COUNTRY_ID
integer
Идентификатор страны, которой соответствует набор полей шаблона реквизита (для получения доступных значений смотрите метод crm.requisite.preset.countries)
DATE_CREATE
datetime
Дата создания
DATE_MODIFY
datetime
Дата изменения. Содержит пустую строку, если шаблон не менялся после создания
CREATED_BY_ID
user
Идентификатор пользователя, создавшего реквизит
MODIFY_BY_ID
user
Идентификатор пользователя, изменившего реквизит
NAME
string
Название реквизита
XML_ID
string
Внешний ключ. Используется для операций обмена. Идентификатор объекта внешней информационной базы.

Назначение поля может меняться конечным разработчиком.

Каждое приложение обеспечивает уникальность значений в этом поле. Рекомендуется использовать уникальный префикс для избежания коллизий с другими приложениями.

В CRM зарезервированы значения вида #CRM_REQUISITE_PRESET_DEF_... для идентификации шаблонов, которые используются по умолчанию. Не следует использовать эти идентификаторы для своих целей, так как это может привести к нарушению логики

ACTIVE
char
Признак активности. Используются значения Y или N. Определяет доступность шаблона в списке выбора при добавлении реквизитов
SORT
integer
Сортировка

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

Название
тип
Описание
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-add)
  • [](./crm-requisite-preset-update)
  • [](./crm-requisite-preset-countries)
  • [](./crm-requisite-preset-get)
  • [](./crm-requisite-preset-list)
  • [](./crm-requisite-preset-delete)

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

Ключевые выводы по теме «Получить описание полей шаблона реквизитов crm.requisite.preset.fields»:

Использование современных стандартов D7 при работе с crm.requisite.preset.fields позволяет писать чистый, масштабируемый и безопасный код. Не забывайте обрабатывать исключения (try/catch) и проверять права доступа текущего пользователя перед выполнением критических операций.

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

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

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

Related Post

Как использовать D7Config() в 1С-Битрикс: пример кодаКак использовать D7Config() в 1С-Битрикс: пример кода

Эффективная интеграция и кастомизация функционала в Битрикс24 часто требует работы на уровне API. Сегодня мы подробно рассмотрим «Как использовать D7Config() в 1С-Битрикс: пример кода». Вы узнаете экспертные методики работы с

Счета (старые)Счета (старые)

Эффективная интеграция и кастомизация функционала в Битрикс24 часто требует работы на уровне API. Сегодня мы подробно рассмотрим «Счета (старые)». Вы узнаете экспертные методики работы с счета (старые) и научитесь избегать

Получить список лог-записей таймлана crm.timeline.logmessage.listПолучить список лог-записей таймлана crm.timeline.logmessage.list

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