метод REST scope: crm

crm.requisite.userfield.update

Изменить пользовательское поле реквизита

Кто может выполнять: администратор, пользователь с правом «Разрешить изменять настройки» в CRM

Описание

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

Параметры

id integer обязательный

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

fields object обязательный

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

Параметр fields

XML_ID string необязательный

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

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

SORT integer необязательный

Сортировка

MULTIPLE char необязательный

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

MANDATORY char необязательный

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

SHOW_FILTER char необязательный

Показывать ли в фильтре списка. Возможные значения:
- N — не показывать
- I — точное совпадение
- E — маска
- S — подстрока

SHOW_IN_LIST char необязательный

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

EDIT_IN_LIST char необязательный

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

IS_SEARCHABLE char необязательный

Участвуют ли значения поля в поиске. Возможные значения:
- Y — да
- 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 '{"id":235,"fields":{"EDIT_FORM_LABEL":"Категория","LIST_COLUMN_LABEL":"Категория","LIST_FILTER_LABEL":"Категория"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.userfield.update

Ответ

HTTP-статус: 200

{
    "result": true,
    "time": {
        "start": 1717769551.504986,
        "finish": 1717769551.817433,
        "duration": 0.31244707107543945,
        "processing": 0.04784202575683594,
        "date_start": "2024-06-07T16:12:31+02:00",
        "date_finish": "2024-06-07T16:12:31+02:00",
        "operating": 0
    }
}

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

result boolean

Результат изменения пользовательского поля реквизита:
- true — изменено
- false — не изменено

time time

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

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

{
    "error": "",
    "error_description": "The entity with ID '235' is not found."
}
Код Описание Значение
Пустая строка Operation is not allowed. Entity ID is not defined Пользовательское поле с указанным идентификатором не найдено
Пустая строка The entity with ID '235' is not found Пользовательское поле с указанным идентификатором не найдено
Пустая строка ID is not defined or invalid Идентификатор пользовательского поля не указан или имеет недопустимое значение
Пустая строка Access denied Недостаточно прав доступа для изменения пользовательского поля
ERROR_CORE Fail to update user field Не удалось изменить пользовательское поле
ERROR_CORE Fail to save enumeration field values Не удалось сохранить значения пользовательского поля списочного типа (например, когда произошло дублирование внешнего ключа одного из значений)

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

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