List Master/Detail Objects

Retrieves a list of standard objects and custom objects that are available for use in MASTER_DETAIL fields.

Because some objects cannot be linked to others with a Master/Detail relationship, you must specify the object to which you are currently planning to add a relationship when you send this request. This request should only return a list of valid objects that can be successfully linked to this object.

Endpoint

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

Request

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

Response

{
  "listMasterDetailObjectsResponse": {
    "operationResult": "SUCCESS",
    "responseDateTime": "2017-05-24T20:52:40.216+0000",
    "masterDetailObjects": {
      "masterDetailObject": [
        {
          "id": "1",
          "name": "account_user"
        },
        {
          "id": "8",
          "name": "contact_activity"
        },
        {
          "id": "2",
          "name": "Custom_Accounts_c"
        },
        {
          "id": "11",
          "name": "donation"
        },
        {
          "id": "14",
          "name": "event_registration"
        },
        {
          "id": "5",
          "name": "Grants_and_Campaigns_c"
        },
        {
          "id": "26",
          "name": "membership_listing"
        },
        {
          "id": "14",
          "name": "New_Obj_c"
        },
        {
          "id": "12",
          "name": "Org_Visitation_c"
        }
        {
          "id": "34",
          "name": "proposal"
        },
        {
          "id": "38",
          "name": "solicitation"
        }
      ]
    }
  }
}

Request Parameters

Parameter Required Description
objectApiName Required This is the token used to identify the Custom Object when accessing it from the API.

Response Parameters

Parameter Description
masterDetailObjects.masterDetailObject.id
masterDetailObjects.masterDetailObject.name

Error Codes

Code Text Description
20001 Object API name is required.
20002 Object API name is invalid.
20020 Object is active.
20024 Object validator name is required.
20025 Object validator error message is required.