userfieldconfig.get

Description and parameters

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

Method returns data about custom field settings with ID.

Parameters

Example

Response example.

{
    "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",
         },
        "editFormLabel": {
            "en": "",
         },
        "listColumnLabel": {
            "en": null,
         },
        "listFilterLabel": {
            "en": null,
         },
        "errorMessage": {
            "en": null,
         },
        "helpMessage": {
            "en": null,
         }
    }
}

Where:

• id - identifier
• entityId - entity string ID
• fieldName - field code
• userTypeId - field type string ID
• xmlId - external ID
• sort - sort index
• multiple - multiple attr. flag
• mandatory - required attr. flag
• showFilter - flag to show in filter
• showInList - flag to show field in list
• editInList - flag permitting field edit in list
• isSearchable - flag for available field value in fulltext index
• settings - list of additional field settings, depends on its type
• languageId - list of language IDs with available phrases
• editFormLabel - list with language-dependent field names, where key - language ID, value - phrase
• listColumnLabel - similar list with phrases for field signature in list (not used)
• listFilterLabel - similar list with phrases for field signature in filter (not used)
• errorMessage - similar list with phrases for error message (not used)
• helpMessage - similar list with hints (not used)
• enum - array with value variants for enumeration list property type:
  • id - variant ID
  • userFieldId - field settings ID
  • value - value
  • def - default flag (N or Y), N by default. Only one variant can be default.
  • sort - sort index
  • xmlId - external variant ID, generated automatically