Browse Inventory Path

Browse Inventory Path

If the request is successful, the API responds with an HTTP 200 OK status code and a list containing the child objects that are located at this hierarchy level. The user can navigate hierarchy using 'up'/'down' links in the result. If there is no 'up' link, you are at the root level. If there is no 'down' link, you have reached a leaf object which is not a parent or other objects in this hierarchy. Depending on the level where you invoke the service, the results should be interpreted differently.

Request
URI
GET
https://{api_host}/vco/api/inventory/**
COPY
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-item of type(s) application/json
{
    "attribute": [
        {
            "displayValue": "string",
            "value": "string",
            "name": "string"
        }
    ],
    "href": "string",
    "relations": {
        "total": 0,
        "start": 0,
        "link": [
            {
                "attribute": [
                    {
                        "displayValue": "string",
                        "value": "string",
                        "name": "string"
                    }
                ],
                "href": "string",
                "type": "string",
                "rel": "string"
            }
        ]
    }
}
attribute
Optional

attribute

string
href
Optional

href

relations
Optional

relations


401

User is not authorized.

Operation doesn't return any data structure