Jump to

• Request
• Response

Get Device Groups and Devices in Tree Representation

get

/api/deviceNavigation/Devices/readForTree

Gets the list of device groups and devices in a format suitable for tree grids.

Request

Query Parameters

• node: string
  The tree node to use. Use root to return all device groups and devices at the root level. Use the node ID for a device group to return child device groups and devices containing the device group.

  Example:

  root

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
  The list of device groups and devices in tree representation.
• message: string
  The response message.

  Example: Loaded children
• 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":"Loaded children"
        },
        "data":{
            "description":"The list of device groups and devices in tree representation.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/deviceNavigationDevicesRead"
            }
        }
    }
}

Nested Schema : data

Type: array

The list of device groups and devices in tree representation.

Show Source

• Array of: object deviceNavigationDevicesRead

{
    "description":"The list of device groups and devices in tree representation.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/deviceNavigationDevicesRead"
    }
}

Nested Schema : deviceNavigationDevicesRead

Type: object

Show Source

• ConditionsTooltip: string
  The conditions tooltip.

  Example:
• CustomName: string
  The custom name.

  Example: Custom Nice Name
• DeviceConditions: string
  The device conditions.

  Example: oracle.doceng.json.BetterJsonNull@76e00bdb
• DeviceID: integer
  The device ID.

  Example: 40
• DeviceName: string
  The device name.

  Example: router.example.com
• DeviceNameEncoded: string
  The encoded device name.

  Example: router.example.com
• DeviceTypeCategoryName: string
  The device type category name.

  Example: Appliance
• DeviceTypeName: string
  The device type name.

  Example: Router
• DeviceTypeVendorName: string
  The vendor name.

  Example: 24+2G
• DeviceZoneID: integer
  The device zone ID for individual CRUD operations.

  Example: 1
• DeviceZoneName: string
  The device zone name.

  Example: Default First Zone
• DNSName: string
  The DNS name.

  Example: router1.example.com
• GeoLocation: string
  The GeoJSON Point of the device's longitude and latitude).

  Example: {"type": "Point", "coordinates": [0.0, 0.0]}
• icon: string
  The icon image.

  Example: fa fa-question-white
• iconCls: string
  The CSS class for icons.

  Example: empty
• IPAddress: string
  The IPv4 address.

  Example: 100.77.220.52
• IPv6Address: string
  The IPv6 Address, in hex notation.

  Example: 2001:DB8::1
• leaf: boolean
  The leaf node of the tree.

  Example: true
• LoadingStates: boolean
  The loading states.

  Example: true
• ParentDeviceID: integer
  The deviceID of parent for virtual devices.

  Example: 0
• SysName: string
  The SNMP system name.

  Example: EXAMPLE-ROUTER
• viewTitle: string
  Title

  Example: Device Overview: router.example.com

{
    "properties":{
        "DeviceID":{
            "description":"The device ID.",
            "type":"integer",
            "example":"40"
        },
        "DeviceName":{
            "description":"The device name.",
            "type":"string",
            "example":"router.example.com"
        },
        "ParentDeviceID":{
            "description":"The <b>deviceID</b> of parent for virtual devices.",
            "type":"integer",
            "example":"0"
        },
        "IPAddress":{
            "description":"The IPv4 address.",
            "type":"string",
            "example":"100.77.220.52"
        },
        "IPv6Address":{
            "description":"The IPv6 Address, in hex notation.",
            "type":"string",
            "example":"2001:DB8::1"
        },
        "DeviceZoneID":{
            "description":"The device zone ID for individual CRUD operations.",
            "type":"integer",
            "example":"1"
        },
        "DeviceZoneName":{
            "description":"The device zone name.",
            "type":"string",
            "example":"Default First Zone"
        },
        "DNSName":{
            "description":"The DNS name.",
            "type":"string",
            "example":"router1.example.com"
        },
        "DeviceTypeCategoryName":{
            "description":"The device type category name.",
            "type":"string",
            "example":"Appliance"
        },
        "DeviceTypeVendorName":{
            "description":"The vendor name.",
            "type":"string",
            "example":"24+2G"
        },
        "DeviceTypeName":{
            "description":"The device type name.",
            "type":"string",
            "example":"Router"
        },
        "DeviceNameEncoded":{
            "description":"The encoded device name.",
            "type":"string",
            "example":"router.example.com"
        },
        "DeviceConditions":{
            "description":"The device conditions.",
            "type":"string",
            "example":null,
            "nullable":true
        },
        "ConditionsTooltip":{
            "description":"The conditions tooltip.",
            "type":"string",
            "example":""
        },
        "icon":{
            "description":"The icon image.",
            "type":"string",
            "example":"fa fa-question-white"
        },
        "iconCls":{
            "description":"The CSS class for icons.",
            "type":"string",
            "example":"empty"
        },
        "leaf":{
            "description":"The leaf node of the tree.",
            "type":"boolean",
            "example":true
        },
        "viewTitle":{
            "description":"Title",
            "type":"string",
            "example":"Device Overview: router.example.com"
        },
        "LoadingStates":{
            "description":"The loading states.",
            "type":"boolean",
            "example":true
        },
        "GeoLocation":{
            "description":"The GeoJSON Point of the device's longitude and latitude).",
            "type":"string",
            "example":"{\"type\": \"Point\", \"coordinates\": [0.0, 0.0]}"
        },
        "CustomName":{
            "description":"The custom name.",
            "type":"string",
            "example":"Custom Nice Name"
        },
        "SysName":{
            "description":"The SNMP system name.",
            "type":"string",
            "example":"EXAMPLE-ROUTER"
        }
    },
    "type":"object"
}

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":{
                "description":"An error.",
                "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
  An error.

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

Nested Schema : items

Type: object

An error.

Back to Top