Создать новое пользовательское поле реквизита crm.requisite.userfield.add

Scope: crm

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

Метод создает новое пользовательское поле для реквизита.

Ограничения для символьного кода пользовательского поля

Системное ограничение на название поля — 20 знаков. К названию пользовательского поля всегда добавляется префикс UF_CRM_, то есть реальная длина названия — 13 знаков.

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

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

Название
тип

Описание

fields*
object

Набор полей — объект вида {"поле": "значение"[, ...]} для добавления пользовательского поля реквизита

Параметр fields

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

Название
тип

Описание

ENTITY_ID*
string

Идентификатор сущности, к которой относится пользовательское поле. Для реквизитов это всегда CRM_REQUISITE

FIELD_NAME*
string

Символьный код. Для реквизитов всегда начинается с префикса UF_CRM_

USER_TYPE_ID*
string

Тип данных (string, boolean, double или datetime)

XML_ID
string

Внешний ключ. Используется для операций обмена. Идентификатор объекта внешней информационной базы.

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

SORT
int

Сортировка

MULTIPLE
char

Признак множественности. Возможные значения:

  • Y — да
  • N — нет

По умолчанию устанавливается N

MANDATORY
char

Признак обязательности. Возможные значения:

  • Y — да
  • N — нет

По умолчанию устанавливается N

SHOW_FILTER
char

Показывать ли в фильтре списка. Возможные значения:

  • N — не показывать
  • I — точное совпадение
  • E — маска
  • S — подстрока

По умолчанию устанавливается N

SHOW_IN_LIST
char

Показывать ли в списке. Возможные значения:

  • Y — да
  • N — нет

По умолчанию устанавливается Y

EDIT_IN_LIST
char

Разрешать ли редактирование пользователем. Возможные значения:

  • Y — да
  • N — нет

По умолчанию устанавливается Y

IS_SEARCHABLE
char

Участвуют ли значения поля в поиске. Возможные значения:

  • Y — да
  • N — нет

По умолчанию устанавливается N

EDIT_FORM_LABEL
string

Подпись в форме редактирования

LIST_COLUMN_LABEL
string

Заголовок в списке

LIST_FILTER_LABEL
string

Подпись фильтра в списке

ERROR_MESSAGE
string

Сообщение об ошибке

HELP_MESSAGE
string

Помощь

LIST
uf_enum_element

Элементы списка. Для получения подробной информации смотрите раздел Получить описание полей для пользовательского поля типа «enumeration» (список) crm.userfield.enumeration.fields

SETTINGS
object

Дополнительные настройки (зависят от типа). Для получения подробной информации смотрите раздел Получить описание полей настроек для типа пользовательского поля crm.userfield.settings.fields

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"USER_TYPE_ID":"string","ENTITY_ID":"CRM_REQUISITE","SORT":100,"MULTIPLE":"N","MANDATORY":"N","SHOW_FILTER":"E","SHOW_IN_LIST":"Y","EDIT_FORM_LABEL":"ПП - Строка","LIST_COLUMN_LABEL":"ПП - Строка","LIST_FILTER_LABEL":"ПП - Строка","FIELD_NAME":"NEWTECH_v1_STRING"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.userfield.add
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"USER_TYPE_ID":"string","ENTITY_ID":"CRM_REQUISITE","SORT":100,"MULTIPLE":"N","MANDATORY":"N","SHOW_FILTER":"E","SHOW_IN_LIST":"Y","EDIT_FORM_LABEL":"ПП - Строка","LIST_COLUMN_LABEL":"ПП - Строка","LIST_FILTER_LABEL":"ПП - Строка","FIELD_NAME":"NEWTECH_v1_STRING"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.requisite.userfield.add
        
try
        {
        	const response = await $b24.callMethod(
        		"crm.requisite.userfield.add",
        		{
        			fields:
        			{
        				"USER_TYPE_ID": "string",
        				"ENTITY_ID": "CRM_REQUISITE",
        				"SORT": 100,
        				"MULTIPLE": "N",
        				"MANDATORY": "N",
        				"SHOW_FILTER": "E",
        				"SHOW_IN_LIST": "Y",
        				"EDIT_FORM_LABEL": "ПП - Строка",
        				"LIST_COLUMN_LABEL": "ПП - Строка",
        				"LIST_FILTER_LABEL": "ПП - Строка",
        				"FIELD_NAME": "NEWTECH_v1_STRING"
        			}
        		}
        	);
        
        	const result = response.getData().result;
        	console.dir(result);
        }
        catch(error)
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.requisite.userfield.add',
                    [
                        'fields' => [
                            'USER_TYPE_ID'      => 'string',
                            'ENTITY_ID'         => 'CRM_REQUISITE',
                            'SORT'              => 100,
                            'MULTIPLE'          => 'N',
                            'MANDATORY'         => 'N',
                            'SHOW_FILTER'       => 'E',
                            'SHOW_IN_LIST'      => 'Y',
                            'EDIT_FORM_LABEL'   => 'ПП - Строка',
                            'LIST_COLUMN_LABEL' => 'ПП - Строка',
                            'LIST_FILTER_LABEL' => 'ПП - Строка',
                            'FIELD_NAME'        => 'NEWTECH_v1_STRING',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding user field: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "crm.requisite.userfield.add",
            {
                fields:
                {
                  "USER_TYPE_ID": "string",
                  "ENTITY_ID": "CRM_REQUISITE",
                  "SORT": 100,
                  "MULTIPLE": "N",
                  "MANDATORY": "N",
                  "SHOW_FILTER": "E",
                  "SHOW_IN_LIST": "Y",
                  "EDIT_FORM_LABEL": "ПП - Строка",
                  "LIST_COLUMN_LABEL": "ПП - Строка",
                  "LIST_FILTER_LABEL": "ПП - Строка",
                  "FIELD_NAME": "NEWTECH_v1_STRING"
              }
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.requisite.userfield.add',
            [
                'fields' => [
                    'USER_TYPE_ID' => 'string',
                    'ENTITY_ID' => 'CRM_REQUISITE',
                    'SORT' => 100,
                    'MULTIPLE' => 'N',
                    'MANDATORY' => 'N',
                    'SHOW_FILTER' => 'E',
                    'SHOW_IN_LIST' => 'Y',
                    'EDIT_FORM_LABEL' => 'ПП - Строка',
                    'LIST_COLUMN_LABEL' => 'ПП - Строка',
                    'LIST_FILTER_LABEL' => 'ПП - Строка',
                    'FIELD_NAME' => 'NEWTECH_v1_STRING'
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": 235,
            "time": {
                "start": 1717681176.885836,
                "finish": 1717681177.353738,
                "duration": 0.46790218353271484,
                "processing": 0.084564208984375,
                "date_start": "2024-06-06T15:39:36+02:00",
                "date_finish": "2024-06-06T15:39:37+02:00",
                "operating": 0
            }
        }

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

Название
тип

Описание

result
integer

Идентификатор созданного пользовательского поля

time
time

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

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

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

{
            "error": "ERROR_CORE",
            "error_description": "Поле UF_CRM_NEWTECH_V1_STRING для объекта CRM_REQUISITE уже существует."
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Текст ошибки

Описание

ERROR_CORE

Поле UF_CRM_NEWTECH_V1_STRING для объекта CRM_REQUISITE уже существует

Попытка повторно создать пользовательское поле с таким же символьным кодом

Пустая строка

The 'USER_TYPE_ID' field is not found

Не задан тип данных пользовательского поля

Пустая строка

The 'FIELD_NAME' field is not found

Не задан символьный код пользовательского поля

Пустая строка

Access denied

Недостаточно прав доступа для добавления пользовательского поля

ERROR_CORE

Fail to create new user field

Не удалось создать пользовательское поле

ERROR_CORE

Fail to save enumumeration field values

Не удалось сохранить значения пользовательского поля списочного типа (например, когда произошло дублирование внешнего ключа одного из значений)

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

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

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

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

Предыдущая
Обзор методов
Следующая
Изменить пользовательское поле реквизита