Retrieve, add, modify, or delete relationships and references.
GET /object/objectType/{objectTypeId}/relationship
Retrieve all relationships for an object type, with the option to references and/or details of linked object types.
Curl Request
curl -X GET --header 'Accept: application/json' --header 'Authorization: bearer YOUR_API_KEY' 'https://YOUR_ENVIRONMENT.resolver.com/object/objectType/6130/relationship?inverse=true&includeObjectTypes=false'
Parameters
| Name | Parameter Type | Data Type | Description | Required |
|---|---|---|---|---|
| objectTypeId | path | double | The internal ID of the object type you want to retrieve the relationships from. | Yes |
| inverse | query | boolean | If true, the response will also include references. | No |
| includeObjectTypes | query | boolean | If true, the response will also include linked object type details. | No |
Success Response
200 OK
Example Response Body
{
"outgoing": [
{
"id": 5186,
"name": "Risks",
"longName": "",
"referenceName": "Assets",
"nameKey": "app:relationship:name:d9611d04-738d-4c4e-afc8-36def232b0ee",
"longNameKey": "app:relationship:longName:c2cde73a-6f9a-4513-912c-66462606e4af",
"referenceNameKey": "app:relationship:referenceName:5e3a69dc-62b5-4001-8a39-3d71c88dac8b",
"objectTypeId": 4180,
"objectTypeGroupId": 3593,
"maximumAllowedEdges": 0,
"created": "2017-11-29T21:23:16.057Z",
"modified": null,
"org": 46,
"externalRefId": "Asset-Risk"
},
{
"id": 5185,
"name": "Attachments",
"longName": "",
"referenceName": "",
"nameKey": "app:relationship:name:bfbe7cda-3a52-4108-94de-e04ec56f4887",
"longNameKey": "app:relationship:longName:ce992ea0-7839-406a-9d61-3f2cd50ade6c",
"referenceNameKey": "app:relationship:referenceName:bcac4669-4421-4599-9f5f-c6195e155fbb",
"objectTypeId": 4180,
"objectTypeGroupId": 3584,
"maximumAllowedEdges": 0,
"created": "2018-11-22T22:42:51.857Z",
"modified": "2018-11-22T22:43:28.918Z",
"org": 46,
"externalRefId": "Asset-Attachment"
}
],
"incoming": [
{
"id": 5247,
"name": "Key Assets",
"longName": "",
"referenceName": "Locations",
"nameKey": "app:relationship:name:e78b742d-ef08-4159-bec4-9d122c856231",
"longNameKey": "app:relationship:longName:a08ff317-4b35-4d0c-89a7-a2aebbf43b36",
"referenceNameKey": "app:relationship:referenceName:be1ac710-7bc5-4434-98db-0af3b3fca41d",
"objectTypeId": 4211,
"objectTypeGroupId": 3595,
"maximumAllowedEdges": 0,
"created": "2017-11-29T21:23:16.057Z",
"modified": "2018-03-19T02:48:33.106Z",
"org": 46,
"externalRefId": "Location-Asset"
},