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(required): 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
  Conditions Tool tip

  Example:
• CustomName: string
  Custom Name

  Example: Custom Nice Name
• DeviceConditions: string
  Device Conditions

  Example: oracle.doceng.json.BetterJsonNull@2fd4312a
• DeviceID: integer
  Device ID

  Example: 40
• DeviceName: string
  Device Name

  Example: router.example.com
• DeviceNameEncoded: string
  Device Name Encoded

  Example: router.example.com
• DeviceTypeCategoryName: string
  Device Type Category Name

  Example: Appliance
• DeviceTypeName: string
  Device Type Name

  Example: (any Cable/DSL Router?)
• DeviceTypeVendorName: string
  Vendor Name

  Example: 24+2G
• DeviceZoneID: integer
  Device Zone ID specified for individual CRUD operations

  Example: 1
• DeviceZoneName: string
  Device Zone Name

  Example: Default First Zone
• DNSName: string
  DNS Name

  Example: router1.example.com
• GeoLocation: string
  GeoJSON Point of device location (lon, lat)

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

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

  Example: empty
• IPAddress: string
  IP Address (v4)

  Example: 100.77.220.52
• IPv6Address: string
  IP Address (v6) - hex notation

  Example: 2001:DB8::1
• leaf: boolean
  Leaf Node of the tree

  Example: true
• LoadingStates: boolean
  Loading States

  Example: true
• ParentDeviceID: integer
  DeviceID of Parent for Virtual Devices

  Example: 0
• SysName: string
  SNMP System Name

  Example: EXAMPLE-ROUTER
• viewTitle: string
  Title

  Example: Device Overview: router.example.com

{
    "properties":{
        "DeviceID":{
            "description":"Device ID",
            "type":"integer",
            "example":"40"
        },
        "DeviceName":{
            "description":"Device Name",
            "type":"string",
            "example":"router.example.com"
        },
        "ParentDeviceID":{
            "description":"DeviceID of Parent for Virtual Devices",
            "type":"integer",
            "example":"0"
        },
        "IPAddress":{
            "description":"IP Address (v4)",
            "type":"string",
            "example":"100.77.220.52"
        },
        "IPv6Address":{
            "description":"IP Address (v6) - hex notation",
            "type":"string",
            "example":"2001:DB8::1"
        },
        "DeviceZoneID":{
            "description":"Device Zone ID specified for individual CRUD operations",
            "type":"integer",
            "example":"1"
        },
        "DeviceZoneName":{
            "description":"Device Zone Name",
            "type":"string",
            "example":"Default First Zone"
        },
        "DNSName":{
            "description":"DNS Name",
            "type":"string",
            "example":"router1.example.com"
        },
        "DeviceTypeCategoryName":{
            "description":"Device Type Category Name",
            "type":"string",
            "example":"Appliance"
        },
        "DeviceTypeVendorName":{
            "description":"Vendor Name",
            "type":"string",
            "example":"24+2G"
        },
        "DeviceTypeName":{
            "description":"Device Type Name",
            "type":"string",
            "example":"(any Cable/DSL Router?)"
        },
        "DeviceNameEncoded":{
            "description":"Device Name Encoded",
            "type":"string",
            "example":"router.example.com"
        },
        "DeviceConditions":{
            "description":"Device Conditions",
            "type":"string",
            "example":null,
            "nullable":true
        },
        "ConditionsTooltip":{
            "description":"Conditions Tool tip",
            "type":"string",
            "example":""
        },
        "icon":{
            "description":"icon image",
            "type":"string",
            "example":"fa fa-question-white"
        },
        "iconCls":{
            "description":"CSS class for icons.",
            "type":"string",
            "example":"empty"
        },
        "leaf":{
            "description":"Leaf Node of the tree",
            "type":"boolean",
            "example":true
        },
        "viewTitle":{
            "description":"Title",
            "type":"string",
            "example":"Device Overview: router.example.com"
        },
        "LoadingStates":{
            "description":"Loading States",
            "type":"boolean",
            "example":true
        },
        "GeoLocation":{
            "description":"GeoJSON Point of device location (lon, lat)",
            "type":"string",
            "example":"{\"type\": \"Point\", \"coordinates\": [0.0, 0.0]}"
        },
        "CustomName":{
            "description":"Custom Name",
            "type":"string",
            "example":"Custom Nice Name"
        },
        "SysName":{
            "description":"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":{
                "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