Jump to

• Request
• Response

Get Device Details

get

/api/device/DeviceViews

Gets the details of the specified device.

Request

Query Parameters

• DetailLevel(required): string
  The level of detail to retrieve. Use Minimal to retrieve only the device name or Full to retrieve all the information on the device.

  Allowed Values: [ "Minimal", "Full" ]

  Example:

  Minimal

• DeviceName(required): string
  The name of the device to get details for.

  Example:

  router.example

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

Match All

Show Source

• object SuccessfulGetOperation
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "description":"The list of details of the specified device.",
                    "type":"array",
                    "items":{
                        "oneOf":[
                            {
                                "$ref":"#/components/schemas/deviceDeviceViews"
                            },
                            {
                                "$ref":"#/components/schemas/deviceDeviceViewsFull"
                            }
                        ]
                    },
                    "example":[
                        {
                            "PropertyName":"Device Name",
                            "PropertyValue":"router.example.com"
                        },
                        {
                            "PropertyName":"Timestamp Added",
                            "PropertyValue":"2022-10-27 07:23:09"
                        },
                        {
                            "PropertyName":"Timestamp Modified",
                            "PropertyValue":"2023-05-16 22:30:26"
                        },
                        {
                            "PropertyName":"IP Address",
                            "PropertyValue":"100.77.220.19"
                        },
                        {
                            "PropertyName":"IPv6 Address",
                            "PropertyValue":null
                        },
                        {
                            "PropertyName":"Device ID",
                            "PropertyValue":"43"
                        },
                        {
                            "PropertyName":"Custom Name",
                            "PropertyValue":""
                        },
                        {
                            "PropertyName":"DNS Name",
                            "PropertyValue":"dev1-col2.ua3.gbucdsint02phx.oraclevcn.com"
                        },
                        {
                            "PropertyName":"Sys Name",
                            "PropertyValue":"dev1-col2"
                        },
                        {
                            "PropertyName":"Sys OID",
                            "PropertyValue":"1.3.6.1.4.1.8072.3.2.10"
                        },
                        {
                            "PropertyName":"Description",
                            "PropertyValue":"Linux router 5.4.17-2136.302.7.2.1.el7uek.x86_64 #2 SMP Tue Jan 18 13:44:44 PST 2022 x86_64"
                        },
                        {
                            "PropertyName":"Location",
                            "PropertyValue":"Unknown"
                        },
                        {
                            "PropertyName":"Contact",
                            "PropertyValue":"root@localhost"
                        },
                        {
                            "PropertyName":"Services",
                            "PropertyValue":"0"
                        },
                        {
                            "PropertyName":"IP Forwarding",
                            "PropertyValue":"1"
                        },
                        {
                            "PropertyName":"Serial Number",
                            "PropertyValue":""
                        },
                        {
                            "PropertyName":"Device Type Name",
                            "PropertyValue":"Linux"
                        },
                        {
                            "PropertyName":"Device Type Category",
                            "PropertyValue":"Appliance"
                        },
                        {
                            "PropertyName":"GeoLocation",
                            "PropertyValue":"{\"type\": \"Point\", \"coordinates\": [0.0, 0.0]}"
                        }
                    ]
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

Show Source

• message: string
  The response message.

  Example: Loaded 1 entries
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
  The list of details of the specified device.
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "description":"The list of details of the specified device.",
            "type":"array",
            "items":{
                "oneOf":[
                    {
                        "$ref":"#/components/schemas/deviceDeviceViews"
                    },
                    {
                        "$ref":"#/components/schemas/deviceDeviceViewsFull"
                    }
                ]
            },
            "example":[
                {
                    "PropertyName":"Device Name",
                    "PropertyValue":"router.example.com"
                },
                {
                    "PropertyName":"Timestamp Added",
                    "PropertyValue":"2022-10-27 07:23:09"
                },
                {
                    "PropertyName":"Timestamp Modified",
                    "PropertyValue":"2023-05-16 22:30:26"
                },
                {
                    "PropertyName":"IP Address",
                    "PropertyValue":"100.77.220.19"
                },
                {
                    "PropertyName":"IPv6 Address",
                    "PropertyValue":null
                },
                {
                    "PropertyName":"Device ID",
                    "PropertyValue":"43"
                },
                {
                    "PropertyName":"Custom Name",
                    "PropertyValue":""
                },
                {
                    "PropertyName":"DNS Name",
                    "PropertyValue":"dev1-col2.ua3.gbucdsint02phx.oraclevcn.com"
                },
                {
                    "PropertyName":"Sys Name",
                    "PropertyValue":"dev1-col2"
                },
                {
                    "PropertyName":"Sys OID",
                    "PropertyValue":"1.3.6.1.4.1.8072.3.2.10"
                },
                {
                    "PropertyName":"Description",
                    "PropertyValue":"Linux router 5.4.17-2136.302.7.2.1.el7uek.x86_64 #2 SMP Tue Jan 18 13:44:44 PST 2022 x86_64"
                },
                {
                    "PropertyName":"Location",
                    "PropertyValue":"Unknown"
                },
                {
                    "PropertyName":"Contact",
                    "PropertyValue":"root@localhost"
                },
                {
                    "PropertyName":"Services",
                    "PropertyValue":"0"
                },
                {
                    "PropertyName":"IP Forwarding",
                    "PropertyValue":"1"
                },
                {
                    "PropertyName":"Serial Number",
                    "PropertyValue":""
                },
                {
                    "PropertyName":"Device Type Name",
                    "PropertyValue":"Linux"
                },
                {
                    "PropertyName":"Device Type Category",
                    "PropertyValue":"Appliance"
                },
                {
                    "PropertyName":"GeoLocation",
                    "PropertyValue":"{\"type\": \"Point\", \"coordinates\": [0.0, 0.0]}"
                }
            ]
        }
    }
}

Nested Schema : data

Type: array

The list of details of the specified device.

Show Source

• Array of: items

{
    "description":"The list of details of the specified device.",
    "type":"array",
    "items":{
        "oneOf":[
            {
                "$ref":"#/components/schemas/deviceDeviceViews"
            },
            {
                "$ref":"#/components/schemas/deviceDeviceViewsFull"
            }
        ]
    },
    "example":[
        {
            "PropertyName":"Device Name",
            "PropertyValue":"router.example.com"
        },
        {
            "PropertyName":"Timestamp Added",
            "PropertyValue":"2022-10-27 07:23:09"
        },
        {
            "PropertyName":"Timestamp Modified",
            "PropertyValue":"2023-05-16 22:30:26"
        },
        {
            "PropertyName":"IP Address",
            "PropertyValue":"100.77.220.19"
        },
        {
            "PropertyName":"IPv6 Address",
            "PropertyValue":null
        },
        {
            "PropertyName":"Device ID",
            "PropertyValue":"43"
        },
        {
            "PropertyName":"Custom Name",
            "PropertyValue":""
        },
        {
            "PropertyName":"DNS Name",
            "PropertyValue":"dev1-col2.ua3.gbucdsint02phx.oraclevcn.com"
        },
        {
            "PropertyName":"Sys Name",
            "PropertyValue":"dev1-col2"
        },
        {
            "PropertyName":"Sys OID",
            "PropertyValue":"1.3.6.1.4.1.8072.3.2.10"
        },
        {
            "PropertyName":"Description",
            "PropertyValue":"Linux router 5.4.17-2136.302.7.2.1.el7uek.x86_64 #2 SMP Tue Jan 18 13:44:44 PST 2022 x86_64"
        },
        {
            "PropertyName":"Location",
            "PropertyValue":"Unknown"
        },
        {
            "PropertyName":"Contact",
            "PropertyValue":"root@localhost"
        },
        {
            "PropertyName":"Services",
            "PropertyValue":"0"
        },
        {
            "PropertyName":"IP Forwarding",
            "PropertyValue":"1"
        },
        {
            "PropertyName":"Serial Number",
            "PropertyValue":""
        },
        {
            "PropertyName":"Device Type Name",
            "PropertyValue":"Linux"
        },
        {
            "PropertyName":"Device Type Category",
            "PropertyValue":"Appliance"
        },
        {
            "PropertyName":"GeoLocation",
            "PropertyValue":"{\"type\": \"Point\", \"coordinates\": [0.0, 0.0]}"
        }
    ]
}

Example:

[
    {
        "PropertyName":"Device Name",
        "PropertyValue":"router.example.com"
    },
    {
        "PropertyName":"Timestamp Added",
        "PropertyValue":"2022-10-27 07:23:09"
    },
    {
        "PropertyName":"Timestamp Modified",
        "PropertyValue":"2023-05-16 22:30:26"
    },
    {
        "PropertyName":"IP Address",
        "PropertyValue":"100.77.220.19"
    },
    {
        "PropertyName":"IPv6 Address",
        "PropertyValue":null
    },
    {
        "PropertyName":"Device ID",
        "PropertyValue":"43"
    },
    {
        "PropertyName":"Custom Name",
        "PropertyValue":""
    },
    {
        "PropertyName":"DNS Name",
        "PropertyValue":"dev1-col2.ua3.gbucdsint02phx.oraclevcn.com"
    },
    {
        "PropertyName":"Sys Name",
        "PropertyValue":"dev1-col2"
    },
    {
        "PropertyName":"Sys OID",
        "PropertyValue":"1.3.6.1.4.1.8072.3.2.10"
    },
    {
        "PropertyName":"Description",
        "PropertyValue":"Linux router 5.4.17-2136.302.7.2.1.el7uek.x86_64 #2 SMP Tue Jan 18 13:44:44 PST 2022 x86_64"
    },
    {
        "PropertyName":"Location",
        "PropertyValue":"Unknown"
    },
    {
        "PropertyName":"Contact",
        "PropertyValue":"root@localhost"
    },
    {
        "PropertyName":"Services",
        "PropertyValue":"0"
    },
    {
        "PropertyName":"IP Forwarding",
        "PropertyValue":"1"
    },
    {
        "PropertyName":"Serial Number",
        "PropertyValue":""
    },
    {
        "PropertyName":"Device Type Name",
        "PropertyValue":"Linux"
    },
    {
        "PropertyName":"Device Type Category",
        "PropertyValue":"Appliance"
    },
    {
        "PropertyName":"GeoLocation",
        "PropertyValue":"{\"type\": \"Point\", \"coordinates\": [0.0, 0.0]}"
    }
]

Nested Schema : items

Match One Schema

Show Source

• object deviceDeviceViews
• object deviceDeviceViewsFull

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/deviceDeviceViews"
        },
        {
            "$ref":"#/components/schemas/deviceDeviceViewsFull"
        }
    ]
}

Nested Schema : deviceDeviceViews

Type: object

Show Source

• PropertyName: string
  The property name.

  Example: DeviceName
• PropertyValue: string
  Value assigned with the property

  Example: router.example

{
    "type":"object",
    "properties":{
        "PropertyName":{
            "description":"The property name.",
            "type":"string",
            "example":"DeviceName"
        },
        "PropertyValue":{
            "description":"Value assigned with the property",
            "type":"string",
            "example":"router.example"
        }
    }
}

Nested Schema : deviceDeviceViewsFull

Type: object

Show Source

• PropertyName: string
  Name of the Property

  Example: DeviceName
• PropertyValue: string
  Value assigned with the property

  Example: router.example

{
    "type":"object",
    "properties":{
        "PropertyName":{
            "description":"Name of the Property",
            "type":"string",
            "example":"DeviceName"
        },
        "PropertyValue":{
            "description":"Value assigned with the property",
            "type":"string",
            "example":"router.example"
        }
    }
}

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