Get Relationship Using GET
The URL path variable 'relationshipType' uses the RelationshipType.representation value. Few sample URLs are shown below. /api/resources/{resourceId}/relationships/children
/api/resources/{resourceId}/relationships/parents
Request
URI
GET
https://{api_host}/api/resources/{id}/relationships/{relationshipType}
COPY
Path Parameters
string
id
Required
The UUID of the resource to set the relationships for
string
relationshipType
Required
The type of relationship of the objects; Uses the RelationshipType.representation value
Possible values are : PARENT, CHILD, ALL,
Query Parameters
integer
page
Optional
Page number from which data needs to be displayed (0-based)
integer
pageSize
Optional
Expected number of entries per page
Responses
200
All the related resources
Returns resource-relation of type(s) application/json
{
"links": [
{
"description": "string",
"href": "string",
"name": "string",
"rel": "string"
}
],
"pageInfo": {
"page": 0,
"pageSize": 0,
"sortBy": "string",
"sortOrder": "string",
"totalCount": 0
},
"relationshipType": "string",
"resourceList": [
{
"badges": [
{
"color": "string",
"score": "number",
"type": "string"
}
],
"creationTime": 0,
"credentialInstanceId": "string",
"description": "string",
"dtEnabled": false,
"extension": {
"anyObjects": [
{}
]
},
"geoLocation": {
"latitude": "number",
"longitude": "number"
},
"identifier": "string",
"links": [
{
"description": "string",
"href": "string",
"name": "string",
"rel": "string"
}
],
"monitoringInterval": 0,
"monitoringIntervalMinutes": 0,
"monitoringIntervalSeconds": 0,
"relatedResources": [
"string"
],
"resourceHealth": "string",
"resourceHealthValue": "number",
"resourceKey": {
"adapterKindKey": "string",
"extension": {
"anyObjects": [
{}
]
},
"links": [
{
"description": "string",
"href": "string",
"name": "string",
"rel": "string"
}
],
"name": "string",
"resourceIdentifiers": [
{
"identifierType": {
"dataType": "string",
"extension": {
"anyObjects": [
{}
]
},
"isPartOfUniqueness": false,
"links": [
{
"description": "string",
"href": "string",
"name": "string",
"rel": "string"
}
],
"name": "string"
},
"key": "string",
"links": [
{
"description": "string",
"href": "string",
"name": "string",
"rel": "string"
}
],
"name": "string",
"uniquelyIdentifying": false,
"value": "string"
}
],
"resourceKindKey": "string"
},
"resourceStatusStates": [
{
"adapterInstanceId": "string",
"resourceState": "string",
"resourceStatus": "string",
"statusMessage": "string"
}
]
}
]
}
string
relationshipType
Optional
The relationship type to the target collection
Possible values are : PARENT, CHILD, CONTAINS, CONTAINED_BY, REFERENCES, REFERENCED_BY, USES, USED_BY, SELF, DESCENDANT, ANCESTOR, TST, ALL,
On This Page
Resource Operations
POST
Add Properties Using POST
POST
Add Properties Using Push Adapter Kind Using POST
POST
Add Relationship Using POST
POST
Add Stats Using POST
POST
Add Stats Using Push Adapter Kind Using POST
DELETE
Delete Relationship Using DELETE
DELETE
Delete Resource Using DELETE
GET
Get DT Stats Of Resource Using GET
GET
Get Latest Stats Using GET
GET
Get Relationships Using GET
GET
Get Relationship Using GET
GET
Get Resource Properties Using GET
GET
Get Resource Using GET
GET
Get Stat Keys Using GET
POST
Get Stats For Resource Using POST
GET
Get Stats Of Resource Using GET
GET
Get Top N Stats Of Resource Using GET
PUT
Mark Resource As Being Maintained Using PUT
PUT
Set Relationship Using PUT
PUT
Start Monitoring Resource Using PUT
PUT
Stop Monitoring Resource Using PUT
DELETE
Unmark Resource As Being Maintained Using DELETE
PUT
Update Geo Location Of Resource Using PUT