Back to Developer Center

API v1 Reference

Create Custom Object List Layout

Creates a new List layout for a custom object.

Endpoint

https://api.neoncrm.com/neonws/services/api/customObject/createCustomObjectListLayout

Request

https://api.neoncrm.com/neonws/services/api/customObject/createCustomObjectListLayout?userSessionId=[session id]&customObjectListLayout.objectApiName=Custom_Event_c&customObjectListLayout.layoutName=Custom%20Event%20Test%20&customObjectListLayout.searchCriteriaFields.layoutField.objectApiName=Custom_Event_c&customObjectListLayout.searchCriteriaFields.layoutField.fieldApiName=name&customObjectListLayout.listFields.layoutField.objectApiName=Custom_Event_c&customObjectListLayout.listFields.layoutField.objectApiName=Custom_Event_c&customObjectListLayout.listFields.layoutField.fieldApiName=name&customObjectListLayout.listFields.layoutField.fieldApiName=Title_c&customObjectListLayout.isDefault=true

Response

{
    "createCustomObjectListLayoutResponse": {
        "operationResult": "SUCCESS",
        "responseDateTime": "2017-12-19T18:36:37.318+0000",
        "customObjectListLayout": {
            "layoutId": 27,
            "layoutName": "Custom Event Test",
            "objectApiName": "Custom_Event_c",
            "searchCriteriaFields": {
                "layoutField": [
                    {
                        "objectApiName": "Custom_Event_c",
                        "fieldApiName": "name"
                    }
                ]
            },
            "listFields": {
                "layoutField": [
                    {
                        "objectApiName": "Custom_Event_c",
                        "fieldApiName": "name"
                    },
                    {
                        "objectApiName": "Custom_Event_c",
                        "fieldApiName": "Title_c"
                    }
                ]
            },
            "isDefault": false
        }
    }
}

Request Parameters

Parameter Required Description
userSessionId Yes
customObjectListLayout.objectApiName Yes
customObjectListLayout.layoutName
To add Search Criteria fields to your layout, include both the objectApiName and fieldApiName parameters for each Search Criteria field. Fields will display in the sequence you send them. Fields can be retrieved using the List Custom Object Fields method.
customObjectListLayout.searchCriteriaFields.layoutField.objectApiName Yes
customObjectListLayout.searchCriteriaFields.layoutField.fieldApiName Yes
To add List fields (columns) to your layout, include both the objectApiName and fieldApiName parameters for each field. Fields will display in the sequence you send them. Fields can be retrieved using the List Custom Object Fields method.
customObjectListLayout.listFields.layoutField.objectApiName Yes
customObjectListLayout.listFields.layoutField.fieldApiName Yes
customObjectListLayout.isDefault Whether to make this layout the default (primary) layout. Possible values: true, false. Default: false.

Response Parameters

Parameter Description
customObjectListLayout.layoutId
customObjectListLayout.layoutName
customObjectListLayout.objectApiName
customObjectListLayout.searchCriteriaFields.layoutField.objectApiName
customObjectListLayout.searchCriteriaFields.layoutField.fieldApiName
customObjectListLayout.listFields.layoutField.objectApiName
customObjectListLayout.listFields.layoutField.fieldApiName
customObjectListLayout.listFields.layoutField.objectApiName
customObjectListLayout.listFields.layoutField.fieldApiName
customObjectListLayout.isDefault