Get Device Vertex in Graph Database

get

/api/deviceNavigation/Devices/readDeviceVertex

Gets the device vertex in the graph database that matches the device name and device zone name.

Request

Query Parameters
  • The device name, including the zone ID (serialized device name). Oracle recommends including the zone ID with the device name. If you do not, you must include it in the DeviceZoneID parameter.
    Example:
    router.example.com;z1 OR router.example.com
  • The ID of the device zone to get performance data for. Deprecated. Use serialized device name instead.
    Example:
    1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : data
Type: array
The required device vertex in the graph database.
Show Source
Nested Schema : deviceNavigationDevicesReadDeviceVertex
Type: object
Show Source

Default Response

Failed operation
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : errors
Type: array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type: object
An error.
Back to Top