Find By Relation

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 
{
    "link": [
        {
            "attribute": [
                {
                    "displayValue": "string",
                    "value": "string",
                    "name": "string"
                }
            ],
            "href": "string",
            "type": "string",
            "rel": "string"
        }
    ],
    "start": 0,
    "total": 0
}
array of Link
link
Optional

link

integer As int32 As int32
start
Optional

start

integer As int32 As int32
total
Optional

total


401

User is not authorized

Operation doesn't return any data structure

On This Page
Catalog Service Operations
GET
Download Icon For Module
GET
Download Icon For Type
GET
Fetch Plugin Metadata
GET
Find By Id
GET
Find By Relation
GET
Find Root Element
GET
Find Simple List Query
GET
List Namespaces
GET
List Object Tags
POST
Tag Object
DELETE
Untag Object