Find By Relation
Every Orchestrator plug-in can define relations between its types. For example, hierarchy structures can be defined as 'CHILDREN' relations between parent and children types. If the request is successful, the API responds with an HTTP 200 OK status code and a list containing the child objects that are accessible through a given relation, if any.
Request
URI
GET
https://{api_host}/vco/api/catalog/{namespace}/{parentType}/{parentId}/{relationName}
COPY
Path Parameters
string
namespace
Required
namespace
string
parentType
Required
parentType
string
parentId
Required
parentId
string
relationName
Required
relationName
Query Parameters
integer
maxResult
Required
maxResult
integer
startIndex
Required
startIndex
boolean
queryCount
Required
queryCount
string of array
keys
Optional
keys
string of array
conditions
Optional
conditions
string of array
sortOrders
Optional
sortOrders
Responses
200
The request is successful
Returns inventory-items of type(s) application/json
{
"total": 0,
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
],
"start": 0
}
integer As int32 As int32
total
Optional
total
integer As int32 As int32
start
Optional
start
401
User is not authorized
Operation doesn't return any data structure