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 corresponding to Devices.DeviceName.

  Example:

  router.example.com

• DeviceZoneName(required): string
  The device zone name.

  Example:

  Default First Zone

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
  Vertex ID

  Example: 037e3b2c-db9a-450b-b715-5287cf4c4c14
• VertexName: string
  Vertex Name

  Example: router.example.com

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