Получить поля шаблона реквизитов по id crm.requisite.preset.get

Scope: crm

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

Метод возвращает шаблон реквизитов по идентификатору.

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

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

Название
тип

Описание

id*
integer

Идентификатор шаблона реквизита. Можно получить с помощью метода crm.requisite.preset.list

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":347}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.preset.get
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":347,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.requisite.preset.get
        
try
        {
        	const response = await $b24.callMethod(
        		"crm.requisite.preset.get",
        		{ id: 347 }    // Идентификатор шаблона реквизита.
        	);
        	
        	const result = response.getData().result;
        	console.dir(result);
        }
        catch( error )
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.requisite.preset.get',
                    [
                        'id' => 347,
                    ]
                );
        
            $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 getting requisite preset: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "crm.requisite.preset.get",
            { id: 347 },    // Идентификатор шаблона реквизита.
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.requisite.preset.get',
            [
                'id' => 347
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": {
                "ID": "347",
                "ENTITY_TYPE_ID": "8",
                "COUNTRY_ID": "1",
                "DATE_CREATE": "2024-05-24T15:45:44+02:00",
                "DATE_MODIFY": "",
                "CREATED_BY_ID": "1",
                "MODIFY_BY_ID": null,
                "NAME": "ИП",
                "XML_ID": "EXAMPLE_COMPANY__VALUE_1",
                "ACTIVE": "Y",
                "SORT": "520"
            },
            "time": {
                "start": 1716558423.336056,
                "finish": 1716558424.695338,
                "duration": 1.3592820167541504,
                "processing": 0.06150317192077637,
                "date_start": "2024-05-24T15:47:03+02:00",
                "date_finish": "2024-05-24T15:47:04+02:00",
                "operating": 0
            }
        }

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

Название
тип

Описание

result
object

Объект, содержащий значения полей шаблона

time
time

Информация о времени выполнения запроса

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

Название
тип

Описание

ID
integer

Идентификатор реквизита. Создается автоматически и уникален в рамках портала

ENTITY_TYPE_ID
integer

Идентификатор типа родительского объекта.

Идентификаторы типов объектов 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

Сортировка

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

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

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

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код

Описание

The Preset with ID '347' 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

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Предыдущая
Получить список стран для шаблона
Следующая
Получить список шаблонов реквизитов по фильтру