Jump to

• Request
• Response

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

• DeviceName(required): string
  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

• DeviceZoneID: integer
  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

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Type: object

Show Source

• data: array data
  The required device vertex in the graph database.
• message: string
  The response message.

  Example:
• 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":""
        },
        "data":{
            "description":"The required device vertex in the graph database.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/deviceNavigationDevicesReadDeviceVertex"
            }
        }
    }
}

Nested Schema : data

Type: array

The required device vertex in the graph database.

Show Source

• Array of: object deviceNavigationDevicesReadDeviceVertex

{
    "description":"The required device vertex in the graph database.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/deviceNavigationDevicesReadDeviceVertex"
    }
}

Nested Schema : deviceNavigationDevicesReadDeviceVertex

Type: object

Show Source

• VertexID: string
  The vertex ID.

  Example: 037e3b2c-db9a-450b-b715-5287cf4c4c14
• VertexName: string
  The vertex name.

  Example: router.example.com

{
    "properties":{
        "VertexID":{
            "description":"The vertex ID.",
            "type":"string",
            "example":"037e3b2c-db9a-450b-b715-5287cf4c4c14"
        },
        "VertexName":{
            "description":"The vertex name.",
            "type":"string",
            "example":"router.example.com"
        }
    },
    "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