Get Resources Relationships Using POST
Get resources that satisfy filtering criteria and are related to specified listof resources with the given relationship type
Request
URI
POST
https://{api_host}/suite-api/api/resources/bulk/relationships
COPY
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
Request Body
Query spec that encapsulates various filtering criteria for related resources look up
resource-relationships-query of type(s) application/json
Required
{
"hierarchyDepth": 0,
"relationshipType": "string",
"resourceIds": [
"string"
],
"resourceQuery": {
"adapterInstanceId": [
"string"
],
"adapterKind": [
"string"
],
"collectorId": [
0
],
"collectorName": [
"string"
],
"credentialId": [
"string"
],
"includeRelated": "string",
"maintenanceScheduleId": [
"string"
],
"name": [
"string"
],
"parentId": [
"string"
],
"propertyConditions": {
"conditions": [
{
"doubleValue": "number",
"key": "string",
"operator": "string",
"stringValue": "string"
}
],
"conjunctionOperator": "string"
},
"propertyName": "string",
"propertyValue": "string",
"recentlyAdded": 0,
"regex": [
"string"
],
"resourceHealth": [
"string"
],
"resourceId": [
"string"
],
"resourceKind": [
"string"
],
"resourceState": [
"string"
],
"resourceStatus": [
"string"
],
"resourceTag": [
{
"category": "string",
"name": "string"
}
],
"statConditions": {
"conditions": [
{
"doubleValue": "number",
"key": "string",
"operator": "string",
"stringValue": "string"
}
],
"conjunctionOperator": "string"
},
"statKey": "string",
"statKeyInclusive": false,
"statKeyLowerBound": "number",
"statKeyUpperBound": "number"
}
}integer As int32 As int32
hierarchyDepth
Optional
Relation hierarchy depth. Used with relationship types DESCENDANT, ANCESTOR and ALL. Defaults to 10.
string
relationshipType
Required
The relationship type of the resources to be extracted. Uses the RelationshipType.representation value.
Possible values are : PARENT, CHILD, DESCENDANT, ANCESTOR, ALL,
array of string
resourceIds
Required
Resource uuids to get the related resources for
Responses
200
The Collection of Resources related to given set of resources and matching the query Spec
Returns resources-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",
"resourcesRelations": [
{
"extension": {
"anyObjects": [
{}
]
},
"links": [
{
"description": "string",
"href": "string",
"name": "string",
"rel": "string"
}
],
"relatedResources": [
"string"
],
"resource": {
"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
Required
The relationship type of the resources
Possible values are : PARENT, CHILD, CONTAINS, CONTAINED_BY, REFERENCES, REFERENCED_BY, USES, USED_BY, SELF, DESCENDANT, ANCESTOR, TST, ALL,
array of resource-relations
resourcesRelations
Required
Resources info combined with lists of query resource identifiers to which they are related
404
If could find none of the resources from ResourceRelationshipsQuery.resourceIds
Operation doesn't return any data structure
500
If there is an error during the query
Operation doesn't return any data structure
On This Page
Resources Operations
POST
Add Group Type Using POST
POST
Add Stats For Resources Using POST
POST
Add Stats For Resources Using Push Adapter Kind Using POST
POST
Create Custom Group Using POST
POST
Create Custom Profile Using POST
POST
Create Resource Using Adapter Instance Using POST
POST
Create Resource Using Adapter Kind Using POST
DELETE
Delete Custom Group Using DELETE
DELETE
Delete Custom Profile Using DELETE
DELETE
Delete Group Type Using DELETE
DELETE
Delete Resources Using DELETE
GET
Get Custom Group Members Using GET
GET
Get Custom Groups Using GET
GET
Get Custom Group Using GET
GET
Get Custom Profiles Using GET
GET
Get Custom Profile Using GET
GET
Get Group Types Using GET
GET
Get Latest Stats Of Resources Using GET
POST
Get Matching Resources Using POST
GET
Get Resource Properties List Using GET
POST
Get Resources Relationships Using POST
GET
Get Resources Using GET
GET
Get Stat Keys Of Resources Using GET
POST
Get Stats And DT For Resources Using POST
POST
Get Stats For Resources Using POST
GET
Get Stats Of Resources Using GET
GET
Get Top N Stats Of Resources Using GET
PUT
Mark Resources As Being Maintained Using PUT
PUT
Modify Custom Group Using PUT
PUT
Modify Custom Profile Using PUT
POST
Query Latest Properties Of Resources Using POST
POST
Query Latest Stats Of Resources Using POST
PUT
Start Monitoring Resources Using PUT
PUT
Stop Monitoring Resources Using PUT
DELETE
Unmark Resources As Being Maintained Using DELETE
PUT
Update Resource Using PUT