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
Optional
Constraints: default: 2147483647

maxResult

integer
startIndex
Optional
Constraints: default: 0

startIndex

boolean
queryCount
Optional
Constraints: default: false

queryCount

string of array
keys
Optional

keys

string of array
conditions
Optional

conditions

string of array
sortOrders
Optional

sortOrders

Authentication
This operation uses the following authentication methods.
Responses
200

The request is successful.

Returns WsInventoryItem of type(s) application/json 
{
    "relations": {
        "startIndex": 0,
        "count": 0,
        "total": 0,
        "link": [
            {
                "rel": "string",
                "type": "string",
                "attributes": [
                    {
                        "name": "string",
                        "displayName": "string",
                        "value": "string",
                        "displayValue": "string"
                    }
                ],
                "href": "string"
            }
        ]
    },
    "attributes": [
        {
            "name": "string",
            "displayName": "string",
            "value": "string",
            "displayValue": "string"
        }
    ],
    "href": "string"
}
object
relations
Optional

relations

array of object
attributes
Optional

attributes

string
href
Optional

href


401

User is not authorized.

Returns WsInventoryItem of type(s) application/json 
"WsInventoryItem Object"
object
relations
Optional

relations

array of object
attributes
Optional

attributes

string
href
Optional

href


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/vco/api/inventory/**
On This Page
Inventory Service Operations
GET
Browse Inventory Path