метод REST scope: crm

crm.requisite.userfield.add

Создать новое пользовательское поле реквизита

Кто может выполнять: администратор, пользователь с правом «Разрешить изменять настройки» в 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 integer необязательный

Сортировка

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 необязательный

Элементы списка. Для получения подробной информации смотрите раздел 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

Ответ

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

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

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

{
    "error": "ERROR_CORE",
    "error_description": "Поле UF_CRM_NEWTECH_V1_STRING для объекта CRM_REQUISITE уже существует."
}
Код Описание Значение
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 enumeration field values Не удалось сохранить значения пользовательского поля списочного типа (например, когда произошло дублирование внешнего ключа одного из значений)

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.