Find By Id

Find By Id

A REST endpoint for retrieving an element by its type and ID. All Orchestrator objects can be accessed or identified by their unique combination of namespace, type and ID.

Request
URI
GET
https://{api_host}/vco/api/catalog/{namespace}/{type}/{id}
COPY
Path Parameters
string
namespace
Required

namespace

string
type
Required

type

string
id
Required

id

Query Parameters
string of array
keys
Optional

keys


Responses
200

The request is successful

Returns inventory-item of type(s) application/json
{
    "attribute": [
        {
            "displayValue": "string",
            "name": "string",
            "value": "string"
        }
    ],
    "href": "string",
    "relations": {
        "total": 0,
        "start": 0,
        "link": [
            {
                "rel": "string",
                "attribute": [
                    {
                        "displayValue": "string",
                        "name": "string",
                        "value": "string"
                    }
                ],
                "href": "string",
                "type": "string"
            }
        ]
    }
}
attribute
Optional

attribute

string
href
Optional

href

relations
Optional

relations


401

User is not authorized

Operation doesn't return any data structure