метод REST scope: userfieldconfig, scope модуля из moduleId (например, crm)

userfieldconfig.list

Получить список настроек пользовательских полей

Кто может выполнять: пользователь с правом чтения объекта, которому принадлежат поля, в модуле moduleId

Описание

Метод userfieldconfig.list возвращает список настроек пользовательских полей по фильтру.

Параметры

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

Идентификатор модуля, в котором выполняется поиск полей

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

Набор полей, которые нужно вернуть (подробное описание)

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

Объект формата:

{
    field_1: value_1,
    field_2: value_2,
    ...,
    field_n: value_n,
}
  • field_n - название поля, по которому будет произведена сортировка выборки
  • value_n - значение типа string, равное:
    - ASC - сортировка по возрастанию
    - DESC - сортировка по убыванию

Список доступных полей для сортировки:
- id - идентификатор пользовательского поля
- fieldName - код пользовательского поля
- userTypeId - тип пользовательского поля
- xmlId - внешний код
- sort - индекс сортировки

По умолчанию:

{
    "sort": "ASC",
    "id": "ASC"
}
filter object необязательный

Объект формата:

{
    field_1: value_1,
    field_2: value_2,
    ...,
    field_n: value_n,
}
  • field_n - название поля, по которому будет отфильтрована выборка пользовательских полей
  • value_n - значение фильтра

Все условия по отдельным полям соединяются с помощью AND.

Смотрите ниже список доступных полей для фильтрации

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

Смещение для постраничной выборки.

Используйте значение параметра next из предыдущего ответа

Параметр select

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

Вернуть все стандартные поля настройки

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

Языковой идентификатор для языковых полей, например ru или en

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

Идентификатор настройки поля

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

Идентификатор объекта

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

Код поля

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

Тип поля

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

Внешний идентификатор

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

Индекс сортировки

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

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

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

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

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

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

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

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

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

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

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

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

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

Дополнительные настройки поля

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

Языковой идентификатор. При передаче этого параметра возвращается набор языковых полей на выбранном языке:
- editFormLabel - подпись в форме редактирования
- listColumnLabel - заголовок в списке
- listFilterLabel - подпись фильтра в списке
- errorMessage - сообщение об ошибке
- helpMessage - помощь

Доступные для фильтрации поля

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

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

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

Код пользовательского поля

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

Тип пользовательского поля

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

Внешний код

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

Индекс сортировки

multiple boolean необязательный

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

mandatory boolean необязательный

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

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

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

showInList boolean необязательный

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

editInList boolean необязательный

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

isSearchable boolean необязательный

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

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"moduleId":"crm","select":{"0":"*","language":"ru"},"order":{"id":"DESC"},"filter":{"multiple":"Y"},"start":0}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/userfieldconfig.list

Ответ

HTTP-статус: 200

{
    "result": {
        "fields": [
            {
                "id": "7095",
                "entityId": "CRM_7",
                "fieldName": "UF_CRM_7_NEW_REST_LIST_2026",
                "userTypeId": "enumeration",
                "xmlId": null,
                "sort": "100",
                "multiple": "Y",
                "mandatory": "N",
                "showFilter": "N",
                "showInList": "Y",
                "editInList": "Y",
                "isSearchable": "N",
                "settings": {
                    "DISPLAY": "LIST",
                    "LIST_HEIGHT": 1,
                    "CAPTION_NO_VALUE": "",
                    "SHOW_NO_VALUE": "Y"
                },
                "languageId": {
                    "ru": "ru"
                },
                "editFormLabel": {
                    "ru": "Список характеристик"
                },
                "listColumnLabel": null,
                "listFilterLabel": null,
                "errorMessage": null,
                "helpMessage": null
            }
        ]
    },
    "next": 50,
    "total": 94,
    "time": {
        "start": 1724239307.903115,
        "finish": 1724239308.567422,
        "duration": 0.6643068790435791,
        "processing": 0.20090818405151367,
        "date_start": "2024-08-21T13:21:47+02:00",
        "date_finish": "2024-08-21T13:21:48+02:00",
        "operating": 0
    }
}

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

result object

Корневой элемент ответа (подробное описание)

total integer

Общее количество найденных настроек

next integer

Смещение следующей страницы.

Поле возвращается, если количество найденных элементов больше 50

time time

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

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

HTTP-статус: 400

{
    "error": "",
    "error_description": "Вы не можете просматривать настройки пользовательских полей"
}
Код Описание Значение
Вы не можете просматривать настройки пользовательских полей Недостаточно прав на чтение полей по переданному фильтру
The current method required more scopes. (crm) У приложения нет нужного scope для модуля из moduleId
No settings for UserFieldAccess Для переданного moduleId не настроен доступ к пользовательским полям

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

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