Получить поля, доступные для добавления в шаблон реквизитов crm.requisite.preset.field.availabletoadd

Scope: crm

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

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

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

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

Название
тип

Описание

preset*
object

Объект, содержащий значение идентификатора шаблона, для которого нужно получить список доступных для добавления настраиваемых полей.

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

Поля с префиксом UF_ в ответе являются пользовательскими (смотрите методы для работы с пользовательскими полями реквизитов)

Примеры кода

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

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.availabletoadd

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.availabletoadd

try
        {
        	const response = await $b24.callMethod(
        		"crm.requisite.preset.field.availabletoadd",
        		{
        			preset:
        			{
        				"ID": 27
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	if(result.error())
        	{
        		console.error(result.error());
        	}
        	else
        	{
        		console.dir(result);
        	}
        }
        catch(error)
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.requisite.preset.field.availabletoadd',
                    [
                        '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 checking available fields: ' . $e->getMessage();
        }

BX24.callMethod(
            "crm.requisite.preset.field.availabletoadd",
            {
                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.availabletoadd',
            [
                'preset' => ['ID' => 27]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": [
                "RQ_FIRST_NAME",
                "RQ_LAST_NAME",
                "RQ_SECOND_NAME",
                "RQ_COMPANY_NAME",
                "RQ_COMPANY_FULL_NAME",
                "RQ_COMPANY_REG_DATE",
                "RQ_DIRECTOR",
                "RQ_ACCOUNTANT",
                "RQ_ADDR",
                "RQ_CONTACT",
                "RQ_EMAIL",
                "RQ_PHONE",
                "RQ_FAX",
                "RQ_IDENT_DOC",
                "RQ_IDENT_DOC_SER",
                "RQ_IDENT_DOC_NUM",
                "RQ_IDENT_DOC_DATE",
                "RQ_IDENT_DOC_ISSUED_BY",
                "RQ_IDENT_DOC_DEP_CODE",
                "RQ_INN",
                "RQ_KPP",
                "RQ_IFNS",
                "RQ_OGRN",
                "RQ_OGRNIP",
                "RQ_OKPO",
                "RQ_OKTMO",
                "RQ_OKVED",
                "RQ_ST_CERT_SER",
                "RQ_ST_CERT_NUM",
                "RQ_ST_CERT_DATE",
                "RQ_SIGNATURE",
                "RQ_STAMP",
                "UF_CRM_1707997209",
                "UF_CRM_1707997236",
                "UF_CRM_1707997253",
                "UF_CRM_1708012333"
            ]
        }

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

Название `тип`	Описание
result `array`	Массив с названиями полей, которые можно добавить в указанный шаблон реквизитов
time `time`	Информация о времени выполнения запроса

Описание полей

Название `тип`	Описание
RQ_FIRST_NAME `string`	Имя
RQ_LAST_NAME `string`	Фамилия
RQ_SECOND_NAME `string`	Отчество
RQ_COMPANY_NAME `string`	Сокращенное наименование организации
RQ_COMPANY_FULL_NAME `string`	Полное наименование организации
RQ_COMPANY_REG_DATE `string`	Дата государственной регистрации
RQ_DIRECTOR `string`	Генеральный директор
RQ_ACCOUNTANT `string`	Главный бухгалтер
RQ_CONTACT `string`	Контактное лицо
RQ_EMAIL `string`	E-Mail
RQ_PHONE `string`	Телефон
RQ_FAX `string`	Факс
RQ_IDENT_DOC `string`	Вид документа
RQ_IDENT_DOC_SER `string`	Серия
RQ_IDENT_DOC_NUM `string`	Номер
RQ_IDENT_DOC_DATE `string`	Дата выдачи
RQ_IDENT_DOC_ISSUED_BY `string`	Кем выдан
RQ_IDENT_DOC_DEP_CODE `string`	Код подразделения
RQ_INN `string`	ИНН
RQ_KPP `string`	КПП
RQ_IFNS `string`	ИФНС
RQ_OGRN `string`	ОГРН
RQ_OGRNIP `string`	ОГРНИП
RQ_OKPO `string`	ОКПО
RQ_OKTMO `string`	ОКТМО
RQ_OKVED `string`	ОКВЭД
RQ_ST_CERT_SER `string`	Серия свидетельства о государственной регистрации
RQ_ST_CERT_NUM `string`	Номер свидетельства о государственной регистрации
RQ_ST_CERT_DATE `string`	Дата свидетельства о государственной регистрации
UF_CRM_1707997209 `double`	Пользовательское поле типа «Число»
UF_CRM_1707997236 `boolean`	Пользовательское поле типа «Да/Нет»
UF_CRM_1707997253 `datetime`	Пользовательское поле типа «Дата»
UF_CRM_1708012333 `string`	Пользовательское поле типа «Строка»

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

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

{
            "error": "",
            "error_description": "Шаблон не найден."
        }

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

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

Код	Описание
`Шаблон не найден`	Не найден шаблон, для которого нужно получить список полей, доступных для добавления

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

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.availabletoadd

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

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

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

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

Описание полейОписание полей

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

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

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

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