Retrieves one specific List layout for a custom object.
Endpoint
https://api.neoncrm.com/neonws/services/api/customObject/retrieveCustomObjectListLayout
Request
https://api.neoncrm.com/neonws/services/api/customObject/retrieveCustomObjectListLayout?userSessionId=[session id]&layoutId=27
Response
{ "retrieveCustomObjectListLayoutResponse": { "operationResult": "SUCCESS", "responseDateTime": "2017-12-19T22:21:50.726+0000", "customObjectListLayout": { "layoutName": "Custom List 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 | |
| layoutId | Yes | The Layout ID to be retrieved. |
Response Parameters
| Parameter | Description |
| customObjectListLayout.layoutName | |
| customObjectListLayout.objectApiName | |
| customObjectListLayout.searchCriteriaFields.layoutField.objectApiName | |
| customObjectListLayout.searchCriteriaFields.layoutField.fieldApiName | |
| customObjectListLayout.listFields.layoutField.objectApiName | |
| customObjectListLayout.listFields.layoutField.fieldApiName | |
| customObjectListLayout.isDefault | |
