userfieldconfig.list

userfieldconfig.list({moduleId: string, select: ?{}, order: ?{}, filter: ?{}, start: number = 0})

Method returns list of custom field settings.

Parameters

Class	Description	Available from version
moduleId	Module string ID. Required.
select	Array with fields to be displayed. Displays all by default, except for variants for list and phrases. To get phrases in the list, pass language ID by the key language
order	List of determining order for display, where key - field name, value - ASC or DESC
filter	List for filtration

Example

Query example

Find all multiple option settings for custom fields from RPA module, sorted by descending IDs, with all fields and language phrases for en language.

{
    "moduleId": "rpa",
    "select": {
        "0": "*",
        "language": "en"
    },
    "order": {
        "id": "DESC"
    },
    "filter": {
        "multiple": "Y"
    }
}

Response format in language phrases is a little bit different, due to phrases being for a single language.

{
    "fields": [
        {
            "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": "Multiple file"
            },
            "listColumnLabel": null,
            "listFilterLabel": null,
            "errorMessage": null,
            "helpMessage": null
        },
        {
            ... 
        }
    ]
}