Jump to

• Request
• Response

Get Network Inventory Status of Devices

get

/api/deviceNavigation/Devices/readStatesNetworks

Gets the network inventory status of the devices specified in DeviceID.

Request

Query Parameters

• DeviceID(required): string
  The comma-separated list of device IDs.

  Example:

  40,10,109,7

• limit: integer(int32)
  The number of records to limit results by.

  Example:

  100

• start: integer(int32)
  The page of results to start from.

  Default Value: 0

  Example:

  1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Type: object

Show Source

• data: array data
• message: string
  The response message.

  Example: Retrieved Network States
• success: boolean
  Whether the operation was a success (true) or failure (false).

  Example: true

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Retrieved Network States"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/deviceNavigationDevicesReadStatesNetworks"
            },
            "example":[
                {
                    "DeviceID":"109",
                    "NetworkDetails":"nodata",
                    "NetworkDetailsData":[
                        [
                            "Unknown"
                        ]
                    ],
                    "LoadingStates":false
                },
                {
                    "DeviceID":"7",
                    "NetworkDetails":"data",
                    "NetworkDetailsData":[
                        [
                            "Server: Net-SNMP Linux",
                            2
                        ],
                        [
                            "Interfaces",
                            8
                        ],
                        [
                            "IP Routes",
                            3
                        ],
                        [
                            "ARP Records",
                            72
                        ],
                        [
                            "MAC Addresses",
                            0
                        ],
                        [
                            "VLANs",
                            0
                        ],
                        [
                            "CDP Neighbors",
                            0
                        ]
                    ],
                    "LoadingStates":false
                }
            ]
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object deviceNavigationDevicesReadStatesNetworks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/deviceNavigationDevicesReadStatesNetworks"
    },
    "example":[
        {
            "DeviceID":"109",
            "NetworkDetails":"nodata",
            "NetworkDetailsData":[
                [
                    "Unknown"
                ]
            ],
            "LoadingStates":false
        },
        {
            "DeviceID":"7",
            "NetworkDetails":"data",
            "NetworkDetailsData":[
                [
                    "Server: Net-SNMP Linux",
                    2
                ],
                [
                    "Interfaces",
                    8
                ],
                [
                    "IP Routes",
                    3
                ],
                [
                    "ARP Records",
                    72
                ],
                [
                    "MAC Addresses",
                    0
                ],
                [
                    "VLANs",
                    0
                ],
                [
                    "CDP Neighbors",
                    0
                ]
            ],
            "LoadingStates":false
        }
    ]
}

Example:

[
    {
        "DeviceID":"109",
        "NetworkDetails":"nodata",
        "NetworkDetailsData":[
            [
                "Unknown"
            ]
        ],
        "LoadingStates":false
    },
    {
        "DeviceID":"7",
        "NetworkDetails":"data",
        "NetworkDetailsData":[
            [
                "Server: Net-SNMP Linux",
                2
            ],
            [
                "Interfaces",
                8
            ],
            [
                "IP Routes",
                3
            ],
            [
                "ARP Records",
                72
            ],
            [
                "MAC Addresses",
                0
            ],
            [
                "VLANs",
                0
            ],
            [
                "CDP Neighbors",
                0
            ]
        ],
        "LoadingStates":false
    }
]

Nested Schema : deviceNavigationDevicesReadStatesNetworks

Type: object

Show Source

• DeviceID: integer
  Device ID

  Example: 40
• LoadingStates: boolean
  Loading States

  Example: false
• NetworkDetails: string
  Indicates whether any networking information have been gathered for the device. Possible values:- "data" and "nodata"

  Example: Some Data
• NetworkDetailsData: array NetworkDetailsData
  Summary accounting information of networking interfaces:- Interfaces, IP Routes, ARP, MAC Addresses, VLANS and CDP Neighbors

{
    "properties":{
        "DeviceID":{
            "description":"Device ID",
            "type":"integer",
            "example":"40"
        },
        "NetworkDetails":{
            "description":"Indicates whether any networking information have been gathered for the device. Possible values:- \"data\" and \"nodata\"",
            "type":"string",
            "example":"Some Data"
        },
        "NetworkDetailsData":{
            "description":"Summary accounting information of networking interfaces:- Interfaces, IP Routes, ARP, MAC Addresses, VLANS and CDP Neighbors",
            "type":"array",
            "items":{
            },
            "example":[
                "Data Details"
            ]
        },
        "LoadingStates":{
            "description":"Loading States",
            "type":"boolean",
            "example":false
        }
    },
    "type":"object"
}

Nested Schema : NetworkDetailsData

Type: array

Summary accounting information of networking interfaces:- Interfaces, IP Routes, ARP, MAC Addresses, VLANS and CDP Neighbors

Show Source

• Array of:

{
    "description":"Summary accounting information of networking interfaces:- Interfaces, IP Routes, ARP, MAC Addresses, VLANS and CDP Neighbors",
    "type":"array",
    "items":{
    },
    "example":[
        "Data Details"
    ]
}

Example:

[
    "Data Details"
]

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

  Example: Exception thrown
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Back to Top