Retrieve Custom Object Form Layout

Retrieves one specific Form layout for a custom object.

Endpoint

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

Request

https://api.neoncrm.com/neonws/services/api/customObject/retrieveCustomObjectFormLayout?userSessionId=[session id]&layoutId=53

Response

{
    "retrieveCustomObjectFormLayoutResponse": {
        "operationResult": "SUCCESS",
        "responseDateTime": "2017-12-19T22:35:37.537+0000",
        "customObjectFormLayout": {
            "layoutName": "Test Form Layout",
            "objectApiName": "Custom_Event_c",
            "formFields": {
                "layoutField": [
                    {
                        "objectApiName": "Custom_Event_c",
                        "fieldApiName": "name"
                    },
                    {
                        "objectApiName": "Custom_Event_c",
                        "fieldApiName": "Title_c"
                    },
                    {
                        "objectApiName": "Custom_Event_c",
                        "fieldApiName": "Account_c"
                    }
                ]
            },
            "isDefault": true
        }
    }
}

Request Parameters

Parameter Required Description
userSessionId Yes
layoutId Yes The ID of the layout to be retrieved.

Response Parameters

Parameter Description
customObjectFormLayout.layoutName
customObjectFormLayout.objectApiName
customObjectFormLayout.formFields.layoutField.objectApiName
customObjectFormLayout.formFields.layoutField.fieldApiName
customObjectFormLayout.isDefault