Back to Developer Center

API v1 Reference

List Custom Object Relations

Retrieves a list of other Custom Objects which reference this object through a relationship.

Endpoint

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

Request

https://api.neoncrm.com/neonws/services/api/customObject/listCustomObjectChildRelations?userSessionId=[session id]&objectApiName=Custom_Event_c

Response

{
    "listCustomObjectChildRelationsResponse": {
        "operationResult": "SUCCESS",
        "responseDateTime": "2017-12-19T18:01:31.726+0000",
        "customObjectRelations": {
            "customObjectRelation": [
                {
                    "objectApiName": "Event_Participant_c",
                    "objectLabel": "Participant",
                    "relationId": 12,
                    "relateListLabel": "Participant"
                },
                {
                    "objectApiName": "Event_Donation_c",
                    "objectLabel": "Donation_Event",
                    "relationId": 14,
                    "relateListLabel": "Donation_Event"
                }
            ]
        }
    }
}

Request Parameters

Parameter Required Description
userSessionId Yes
objectApiName Yes

Response Parameters

Parameter Description
customObjectRelations.customObjectRelation.objectApiName
customObjectRelations.customObjectRelation.objectLabel
customObjectRelations.customObjectRelation.relationId
customObjectRelations.customObjectRelation.relateListLabel