Get association by ID
GET/associations/:associationId
Using this api you can get SYSTEM_DEFINED / USER_DEFINED association by id
Request
Version stringrequired
API Version
Available options
v3associationId stringrequired
Successful response
- application/json
- Schema
- Example (auto)
Schema
locationIdstringrequired
idstringrequired
keystringrequired
First Objects Association Label (custom_objects.children)
firstObjectLabelobjectrequired
First Objects Association Label (custom_objects.children)
firstObjectKeyobjectrequired
First Objects Key
secondObjectLabelobjectrequired
Second Object Association Label (contact)
secondObjectKeyobjectrequired
Second Objects Key
associationTypeobjectrequired
Association Type can be USER_DEFINED or SYSTEM_DEFINED
{
"locationId": "string",
"id": "ve9EPM428h8vShlRW1KT",
"key": "student",
"firstObjectLabel": "student",
"firstObjectKey": "custom_objects.children",
"secondObjectLabel": "Teacher",
"secondObjectKey": "contact",
"associationType": "USER_DEFINED"
}