Создать шаблон crm.requisite.preset.add

Scope: crm

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

Метод создает новый шаблон реквизитов.

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

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

Название `тип`	Описание
fields* `object`	Набор полей — объект вида `{"поле": "значение"[, ...]}` для добавления шаблона

Параметр fields

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

Название `тип`	Описание
ENTITY_TYPE_ID* `integer`	Идентификатор типа родительского объекта. Сейчас это только «Реквизит» (идентификатор `8`). Идентификаторы типов объектов CRM отдает метод crm.enum.ownertype
COUNTRY_ID* `integer`	Идентификатор страны, которой соответствует набор полей шаблона реквизита (для получения доступных значений смотрите метод crm.requisite.preset.countries)
NAME* `string`	Название реквизита
XML_ID `string`	Внешний ключ. Используется для операций обмена. Идентификатор объекта внешней информационной базы. Назначение поля может меняться конечным разработчиком. Каждое приложение обеспечивает уникальность значений в этом поле. Рекомендуется использовать уникальный префикс для избежания коллизий с другими приложениями. В CRM зарезервированы значения вида `#CRM_REQUISITE_PRESET_DEF_...` для идентификации шаблонов, которые используются по умолчанию. Не следует использовать эти идентификаторы для своих целей, так как это может привести к нарушению логики
ACTIVE `char`	Признак активности. Используются значения `Y` или `N`. Определяет доступность шаблона в списке выбора при добавлении реквизитов
SORT `integer`	Сортировка

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"ENTITY_TYPE_ID":8,"COUNTRY_ID":1,"NAME":"ИП","XML_ID":"EXAMPLE_COMPANY__VALUE_1","ACTIVE":"Y","SORT":520}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.preset.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"ENTITY_TYPE_ID":8,"COUNTRY_ID":1,"NAME":"ИП","XML_ID":"EXAMPLE_COMPANY__VALUE_1","ACTIVE":"Y","SORT":520},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.requisite.preset.add

try
        {
        	const response = await $b24.callMethod(
        		"crm.requisite.preset.add",
        		{
        			fields:
        			{
        				"ENTITY_TYPE_ID": 8,    // Для шаблона реквизитов всегда указывается "Реквизит" (идентификатор 8), см. crm.enum.ownertype
        				"COUNTRY_ID": 1,        // Россия
        				"NAME": "ИП",
        				"XML_ID": "EXAMPLE_COMPANY__VALUE_1",    // Уникальный внешний идентификатор
        				"ACTIVE": "Y",
        				"SORT": 520    // Порядок в списке шаблонов
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info("Создан шаблон с ID " + result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.requisite.preset.add',
                    [
                        'fields' => [
                            'ENTITY_TYPE_ID' => 8,
                            'COUNTRY_ID'     => 1,
                            'NAME'           => 'ИП',
                            'XML_ID'         => 'EXAMPLE_COMPANY__VALUE_1',
                            'ACTIVE'         => 'Y',
                            'SORT'           => 520,
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Создан шаблон с ID ' . $result;
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Ошибка при создании шаблона: ' . $e->getMessage();
        }

BX24.callMethod(
            "crm.requisite.preset.add",
            {
                fields:
                {
                    "ENTITY_TYPE_ID": 8,    // Для шаблона реквизитов всегда указывается "Реквизит" (идентификатор 8), см. crm.enum.ownertype
                    "COUNTRY_ID": 1,        // Россия
                    "NAME": "ИП",
                    "XML_ID": "EXAMPLE_COMPANY__VALUE_1",    // Уникальный внешний идентификатор
                    "ACTIVE": "Y",
                    "SORT": 520    // Порядок в списке шаблонов
                }
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.info("Создан шаблон с ID " + result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.requisite.preset.add',
            [
                'fields' =>
                [
                    'ENTITY_TYPE_ID' => 8,
                    'COUNTRY_ID' => 1,
                    'NAME' => 'ИП',
                    'XML_ID' => 'EXAMPLE_COMPANY__VALUE_1',
                    'ACTIVE' => 'Y',
                    'SORT' => 520
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": 347,
            "time": {
                "start": 1716543593.35189,
                "finish": 1716543593.683898,
                "duration": 0.33200788497924805,
                "processing": 0.016175031661987305,
                "date_start": "2024-05-24T11:39:53+02:00",
                "date_finish": "2024-05-24T11:39:53+02:00",
                "operating": 0
            }
        }

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

Название `тип`	Описание
result `integer`	Идентификатор созданного шаблона реквизитов
time `time`	Информация о времени выполнения запроса

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

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

{
            "error": "",
            "error_description": "ENTITY_TYPE_ID is not defined or invalid"
        }

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

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

Код	Описание
`ENTITY_TYPE_ID is not defined or invalid`	Идентификатор типа родительского объекта не определен или имеет недопустимое значение
`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	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Обзор методов

Изменить шаблон реквизита

Создать шаблон crm.requisite.preset.add

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

Параметр fieldsПараметр fields

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

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

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

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

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

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

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