userfieldconfig.get

Описание и параметры

userfieldconfig.get({id: number, moduleId: string})

Метод вернет данные о настройках пользовательского поля с идентификатором id.

Параметры

Пример

Пример ответа.

{
    "field": {
        "id": "165",
        "entityId": "RPA_1",
        "fieldName": "UF_RPA_1_1585069397",
        "userTypeId": "file",
        "xmlId": null,
        "sort": "100",
        "multiple": "Y",
        "mandatory": "N",
        "showFilter": "E",
        "showInList": "Y",
        "editInList": "Y",
        "isSearchable": "Y",
        "settings": {
            "SIZE": 20,
            "LIST_WIDTH": 0,
            "LIST_HEIGHT": 0,
            "MAX_SHOW_SIZE": 0,
            "MAX_ALLOWED_SIZE": 0,
            "EXTENSIONS": []
        },
        "languageId": {
            "en": "en",
            "ru": "ru"
        },
        "editFormLabel": {
            "en": "",
            "ru": "Множественный файл"
        },
        "listColumnLabel": {
            "en": null,
            "ru": null
        },
        "listFilterLabel": {
            "en": null,
            "ru": null
        },
        "errorMessage": {
            "en": null,
            "ru": null
        },
        "helpMessage": {
            "en": null,
            "ru": null
        }
    }
}

Где:

• id - идентификатор
• entityId - строковый идентификатор сущности
• fieldName - код поля
• userTypeId - строковый идентификатор типа поля
• xmlId - внешний идентификатор
• sort - индекс сортировки
• multiple - флаг множественности
• mandatory - флаг обязательности
• showFilter - флаг показа поля в фильтре
• showInList - флаг показа поля в списке
• editInList - флаг разрешения редактирования поля в списке
• isSearchable - флаг наличия значения поля в полнотекстовом индексе
• settings - список дополнительных настроек поля, зависит от его типа
• languageId - список идентификаторов языков, для которых есть фразы
• editFormLabel - список с языкозависимыми названиями поля, где ключ - идентификатор языка, а значение - фраза
• listColumnLabel - аналогичный список фраз для подписи поля в списке (не используется)
• listFilterLabel - аналогичный список фраз для подписи поля в фильтре (не используется)
• errorMessage - аналогичный список фраз для сообщения об ошибке (не используется)
• helpMessage - аналогичный список подсказок (не используется)
• enum - массив с вариантами значений для свойств типа список enumeration:
  • id - идентификатор варианта
  • userFieldId - идентификатор настроек поля
  • value - значение
  • def - флаг по умолчанию (N или Y), по умолчанию N. Только один может быть вариантом по умолчанию.
  • sort - индекс сортировки
  • xmlId - внешний идентификатор варианта, генерируется автоматически