Vco Inventory Get Inventory Items

Gets all of the inventory information available with this VCO. This method does not have required parameters. The optional parameters are enterpriseId - Returns inventory items belonging to the specified enterprise. If the caller context is an enterprise, then this value will be taken from the token itself. modifiedSince - Returns inventory items that have been modified in the last modifiedSince hours. with - Array containing the string "edge" to get details about the provisioned Edge, if any.

Request

URI

POST

https://{api_host}/portal/rest/vcoInventory/getInventoryItems

COPY

Request Body

{
    "enterpriseId": 0,
    "enterpriseProxyId": 0,
    "modifiedSince": 0,
    "with": [
        "string"
    ]
}

integer

enterpriseId

Optional

enterpriseId

integer

enterpriseProxyId

Optional

enterpriseProxyId

integer

modifiedSince

Optional

modifiedSince

array of string

with

Optional

with

Possible values are : edge, vcoOwner, managedVco, enterprise, enterpriseProxy,

Responses

200

Inventory items belonging available at the VCO

Returns Array of inventory_item of type(s) application/json

[
    {
        "id": 0,
        "deviceSerialNumber": "string",
        "deviceUuid": "string",
        "modelNumber": "string",
        "siteId": 0,
        "description": "string",
        "acknowledged": 0,
        "edgeId": 0,
        "edge": {
            "id": 0,
            "edge": "string",
            "site": {
                "name": "string"
            }
        },
        "inventoryState": "string",
        "inventoryEdgeState": "string",
        "inventoryAction": "string",
        "vcoOwnerId": 0,
        "vcoOwner": {
            "accountNumber": "string",
            "name": "string"
        },
        "modified": "string"
    }
]

On This Page

Description

Request

Request Body

Response

200 Response Body

Vco Inventory Operations

POST

Vco Inventory Associate Edges

POST

Vco Inventory Associate Existing Edge

POST