Jump to

• Request
• Response

Get the Status of a Topology Widget

post

/api/graph/NodeDetails/read

Gets the status for the topology widget status that matches the specified vertex or edge class.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Match One Schema

Show Source

• object graphNodeDetailsVertexClass
• object graphNodeDetailsEdgeClass

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/graphNodeDetailsVertexClass"
        },
        {
            "$ref":"#/components/schemas/graphNodeDetailsEdgeClass"
        }
    ]
}

Nested Schema : graphNodeDetailsVertexClass

Type: object

Show Source

• Widgets: array Widgets
  The contents of Widgets can changed dramatically based on the vertex and edge properties.The following is just a sample widget.

{
    "properties":{
        "Widgets":{
            "description":"The contents of Widgets can changed dramatically based on the vertex and edge properties.The following is just a sample widget.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "depth":{
                        "description":"Number of hops from the start vertex.",
                        "type":"integer",
                        "example":0
                    },
                    "ZoneID":{
                        "description":"Zone ID",
                        "type":"string",
                        "example":"3"
                    },
                    "DeviceID":{
                        "description":"Device ID",
                        "type":"integer",
                        "example":349
                    },
                    "VertexClass":{
                        "description":"Type of the node",
                        "type":"string",
                        "example":"Device"
                    },
                    "VertexID":{
                        "description":"Vertex ID",
                        "type":"string",
                        "example":"1c730895-8505-43a9-ac8e-f18c75edcde9"
                    },
                    "IPAddress":{
                        "description":"IP Address",
                        "type":"string",
                        "example":"100.77.220.52"
                    },
                    "TimestampModified":{
                        "description":"Time stamp Modified",
                        "type":"string",
                        "example":"2023-09-03 06:00:18"
                    },
                    "Name":{
                        "description":"Name of the node",
                        "type":"string",
                        "example":"Element1"
                    },
                    "NodeIcon":{
                        "description":"Path to the image icon used to represent the node. Each node will only have one of the following= NodeIcon, NodeFontAwesomeIcon, and NodeUANIcon",
                        "type":"string",
                        "example":"fa fa-server-network"
                    },
                    "NodeFontAwesomeIcon":{
                        "description":"FontAwesome icon class. Each node will only have one of the following= NodeIcon, NodeFontAwesomeIcon, and NodeUANIcon.",
                        "type":"string",
                        "example":"fa fa-server-network"
                    },
                    "NodeUANIcon":{
                        "description":"Universal Assurance Network icon class. Each node will only have one of the following= NodeIcon, NodeFontAwesomeIcon, and NodeUANIcon.",
                        "type":"string"
                    },
                    "Group":{
                        "description":"To check the node is part of tuck away group.",
                        "type":"boolean",
                        "example":true
                    },
                    "radius":{
                        "description":"Node radius",
                        "type":"integer",
                        "example":20
                    },
                    "open":{
                        "description":"Indicates if the node is open (expanded) or not.",
                        "type":"boolean",
                        "example":false
                    },
                    "groupId":{
                        "description":"ID to link a nested node back to its parent.",
                        "type":"string",
                        "example":"1c730895-8505-43a9-ac8e-f18c75edcde9"
                    },
                    "_type":{
                        "description":"Type of the node",
                        "type":"string",
                        "example":"Device"
                    },
                    "_id":{
                        "description":"Vertex Id",
                        "type":"string",
                        "example":"1c730895-8505-43a9-ac8e-f18c75edcde9"
                    }
                }
            }
        }
    }
}

Nested Schema : graphNodeDetailsEdgeClass

Type: object

Show Source

• Widgets: array Widgets
  The contents of Widgets can changed dramatically based on the vertex and edge properties.The following is just a sample widget.

{
    "properties":{
        "Widgets":{
            "description":"The contents of Widgets can changed dramatically based on the vertex and edge properties.The following is just a sample widget.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "HopCount":{
                        "description":"Hop Count",
                        "type":"integer",
                        "example":1
                    },
                    "LineSize":{
                        "description":"Width of the edge.",
                        "type":"integer",
                        "example":1
                    },
                    "Stroke":{
                        "description":"Line Style",
                        "type":"string",
                        "example":"Solid"
                    },
                    "Type":{
                        "description":"Edge Type",
                        "type":"string",
                        "example":"ConnectsLayer2"
                    },
                    "TypeDirection":{
                        "description":"Indicator of the edge tip style. Directional indicates the edge has an arrow pointing from source to target. Non-Directional indicates the edge has no arrows on the tips.\n\n|Allowed Values:\n|  Non-Directional\n|  Directional",
                        "type":"string",
                        "example":"Non-Directed"
                    },
                    "TimestampModified":{
                        "description":"Timestamp Modified",
                        "type":"string",
                        "example":"2023-09-05 06:00:18"
                    },
                    "id":{
                        "description":"Edge ID",
                        "type":"string",
                        "example":"c59a9d9e-b610-4a9e-bfec-eb522a218fe8,1c730895-8505-43a9-ac8e-f18c75edcde9,984921d9-35cc-4571-acc9-6158004c7e53_c59a9d9e-b610-4a9e-bfec-eb522a218fe8_1c730895-8505-43a9-ac8e-f18c75edcde9"
                    },
                    "EdgeClass":{
                        "description":"Edge Class",
                        "type":"string",
                        "example":"ConnectsLayer2"
                    },
                    "_type":{
                        "description":"Edge Class Type",
                        "type":"string",
                        "example":"ConnectsLayer2"
                    },
                    "_id":{
                        "description":"Edge Class ID",
                        "type":"string",
                        "example":"984921d9-35cc-4571-acc9-6158004c7e53_c59a9d9e-b610-4a9e-bfec-eb522a218fe8_1c730895-8505-43a9-ac8e-f18c75edcde9"
                    }
                }
            }
        }
    }
}

Nested Schema : Widgets

Type: array

The contents of Widgets can changed dramatically based on the vertex and edge properties.The following is just a sample widget.

Show Source

• Array of: object items

{
    "description":"The contents of Widgets can changed dramatically based on the vertex and edge properties.The following is just a sample widget.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "depth":{
                "description":"Number of hops from the start vertex.",
                "type":"integer",
                "example":0
            },
            "ZoneID":{
                "description":"Zone ID",
                "type":"string",
                "example":"3"
            },
            "DeviceID":{
                "description":"Device ID",
                "type":"integer",
                "example":349
            },
            "VertexClass":{
                "description":"Type of the node",
                "type":"string",
                "example":"Device"
            },
            "VertexID":{
                "description":"Vertex ID",
                "type":"string",
                "example":"1c730895-8505-43a9-ac8e-f18c75edcde9"
            },
            "IPAddress":{
                "description":"IP Address",
                "type":"string",
                "example":"100.77.220.52"
            },
            "TimestampModified":{
                "description":"Time stamp Modified",
                "type":"string",
                "example":"2023-09-03 06:00:18"
            },
            "Name":{
                "description":"Name of the node",
                "type":"string",
                "example":"Element1"
            },
            "NodeIcon":{
                "description":"Path to the image icon used to represent the node. Each node will only have one of the following= NodeIcon, NodeFontAwesomeIcon, and NodeUANIcon",
                "type":"string",
                "example":"fa fa-server-network"
            },
            "NodeFontAwesomeIcon":{
                "description":"FontAwesome icon class. Each node will only have one of the following= NodeIcon, NodeFontAwesomeIcon, and NodeUANIcon.",
                "type":"string",
                "example":"fa fa-server-network"
            },
            "NodeUANIcon":{
                "description":"Universal Assurance Network icon class. Each node will only have one of the following= NodeIcon, NodeFontAwesomeIcon, and NodeUANIcon.",
                "type":"string"
            },
            "Group":{
                "description":"To check the node is part of tuck away group.",
                "type":"boolean",
                "example":true
            },
            "radius":{
                "description":"Node radius",
                "type":"integer",
                "example":20
            },
            "open":{
                "description":"Indicates if the node is open (expanded) or not.",
                "type":"boolean",
                "example":false
            },
            "groupId":{
                "description":"ID to link a nested node back to its parent.",
                "type":"string",
                "example":"1c730895-8505-43a9-ac8e-f18c75edcde9"
            },
            "_type":{
                "description":"Type of the node",
                "type":"string",
                "example":"Device"
            },
            "_id":{
                "description":"Vertex Id",
                "type":"string",
                "example":"1c730895-8505-43a9-ac8e-f18c75edcde9"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• _id: string
  Vertex Id

  Example: 1c730895-8505-43a9-ac8e-f18c75edcde9
• _type: string
  Type of the node

  Example: Device
• depth: integer
  Number of hops from the start vertex.

  Example: 0
• DeviceID: integer
  Device ID

  Example: 349
• Group: boolean
  To check the node is part of tuck away group.

  Example: true
• groupId: string
  ID to link a nested node back to its parent.

  Example: 1c730895-8505-43a9-ac8e-f18c75edcde9
• IPAddress: string
  IP Address

  Example: 100.77.220.52
• Name: string
  Name of the node

  Example: Element1
• NodeFontAwesomeIcon: string
  FontAwesome icon class. Each node will only have one of the following= NodeIcon, NodeFontAwesomeIcon, and NodeUANIcon.

  Example: fa fa-server-network
• NodeIcon: string
  Path to the image icon used to represent the node. Each node will only have one of the following= NodeIcon, NodeFontAwesomeIcon, and NodeUANIcon

  Example: fa fa-server-network
• NodeUANIcon: string
  Universal Assurance Network icon class. Each node will only have one of the following= NodeIcon, NodeFontAwesomeIcon, and NodeUANIcon.
• open: boolean
  Indicates if the node is open (expanded) or not.

  Example: false
• radius: integer
  Node radius

  Example: 20
• TimestampModified: string
  Time stamp Modified

  Example: 2023-09-03 06:00:18
• VertexClass: string
  Type of the node

  Example: Device
• VertexID: string
  Vertex ID

  Example: 1c730895-8505-43a9-ac8e-f18c75edcde9
• ZoneID: string
  Zone ID

  Example: 3

{
    "type":"object",
    "properties":{
        "depth":{
            "description":"Number of hops from the start vertex.",
            "type":"integer",
            "example":0
        },
        "ZoneID":{
            "description":"Zone ID",
            "type":"string",
            "example":"3"
        },
        "DeviceID":{
            "description":"Device ID",
            "type":"integer",
            "example":349
        },
        "VertexClass":{
            "description":"Type of the node",
            "type":"string",
            "example":"Device"
        },
        "VertexID":{
            "description":"Vertex ID",
            "type":"string",
            "example":"1c730895-8505-43a9-ac8e-f18c75edcde9"
        },
        "IPAddress":{
            "description":"IP Address",
            "type":"string",
            "example":"100.77.220.52"
        },
        "TimestampModified":{
            "description":"Time stamp Modified",
            "type":"string",
            "example":"2023-09-03 06:00:18"
        },
        "Name":{
            "description":"Name of the node",
            "type":"string",
            "example":"Element1"
        },
        "NodeIcon":{
            "description":"Path to the image icon used to represent the node. Each node will only have one of the following= NodeIcon, NodeFontAwesomeIcon, and NodeUANIcon",
            "type":"string",
            "example":"fa fa-server-network"
        },
        "NodeFontAwesomeIcon":{
            "description":"FontAwesome icon class. Each node will only have one of the following= NodeIcon, NodeFontAwesomeIcon, and NodeUANIcon.",
            "type":"string",
            "example":"fa fa-server-network"
        },
        "NodeUANIcon":{
            "description":"Universal Assurance Network icon class. Each node will only have one of the following= NodeIcon, NodeFontAwesomeIcon, and NodeUANIcon.",
            "type":"string"
        },
        "Group":{
            "description":"To check the node is part of tuck away group.",
            "type":"boolean",
            "example":true
        },
        "radius":{
            "description":"Node radius",
            "type":"integer",
            "example":20
        },
        "open":{
            "description":"Indicates if the node is open (expanded) or not.",
            "type":"boolean",
            "example":false
        },
        "groupId":{
            "description":"ID to link a nested node back to its parent.",
            "type":"string",
            "example":"1c730895-8505-43a9-ac8e-f18c75edcde9"
        },
        "_type":{
            "description":"Type of the node",
            "type":"string",
            "example":"Device"
        },
        "_id":{
            "description":"Vertex Id",
            "type":"string",
            "example":"1c730895-8505-43a9-ac8e-f18c75edcde9"
        }
    }
}

Nested Schema : Widgets

Type: array

The contents of Widgets can changed dramatically based on the vertex and edge properties.The following is just a sample widget.

Show Source

• Array of: object items

{
    "description":"The contents of Widgets can changed dramatically based on the vertex and edge properties.The following is just a sample widget.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "HopCount":{
                "description":"Hop Count",
                "type":"integer",
                "example":1
            },
            "LineSize":{
                "description":"Width of the edge.",
                "type":"integer",
                "example":1
            },
            "Stroke":{
                "description":"Line Style",
                "type":"string",
                "example":"Solid"
            },
            "Type":{
                "description":"Edge Type",
                "type":"string",
                "example":"ConnectsLayer2"
            },
            "TypeDirection":{
                "description":"Indicator of the edge tip style. Directional indicates the edge has an arrow pointing from source to target. Non-Directional indicates the edge has no arrows on the tips.\n\n|Allowed Values:\n|  Non-Directional\n|  Directional",
                "type":"string",
                "example":"Non-Directed"
            },
            "TimestampModified":{
                "description":"Timestamp Modified",
                "type":"string",
                "example":"2023-09-05 06:00:18"
            },
            "id":{
                "description":"Edge ID",
                "type":"string",
                "example":"c59a9d9e-b610-4a9e-bfec-eb522a218fe8,1c730895-8505-43a9-ac8e-f18c75edcde9,984921d9-35cc-4571-acc9-6158004c7e53_c59a9d9e-b610-4a9e-bfec-eb522a218fe8_1c730895-8505-43a9-ac8e-f18c75edcde9"
            },
            "EdgeClass":{
                "description":"Edge Class",
                "type":"string",
                "example":"ConnectsLayer2"
            },
            "_type":{
                "description":"Edge Class Type",
                "type":"string",
                "example":"ConnectsLayer2"
            },
            "_id":{
                "description":"Edge Class ID",
                "type":"string",
                "example":"984921d9-35cc-4571-acc9-6158004c7e53_c59a9d9e-b610-4a9e-bfec-eb522a218fe8_1c730895-8505-43a9-ac8e-f18c75edcde9"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• _id: string
  Edge Class ID

  Example: 984921d9-35cc-4571-acc9-6158004c7e53_c59a9d9e-b610-4a9e-bfec-eb522a218fe8_1c730895-8505-43a9-ac8e-f18c75edcde9
• _type: string
  Edge Class Type

  Example: ConnectsLayer2
• EdgeClass: string
  Edge Class

  Example: ConnectsLayer2
• HopCount: integer
  Hop Count

  Example: 1
• id: string
  Edge ID

  Example: c59a9d9e-b610-4a9e-bfec-eb522a218fe8,1c730895-8505-43a9-ac8e-f18c75edcde9,984921d9-35cc-4571-acc9-6158004c7e53_c59a9d9e-b610-4a9e-bfec-eb522a218fe8_1c730895-8505-43a9-ac8e-f18c75edcde9
• LineSize: integer
  Width of the edge.

  Example: 1
• Stroke: string
  Line Style

  Example: Solid
• TimestampModified: string
  Timestamp Modified

  Example: 2023-09-05 06:00:18
• Type: string
  Edge Type

  Example: ConnectsLayer2
• TypeDirection: string
  Indicator of the edge tip style. Directional indicates the edge has an arrow pointing from source to target. Non-Directional indicates the edge has no arrows on the tips. |Allowed Values: | Non-Directional | Directional

  Example: Non-Directed

{
    "type":"object",
    "properties":{
        "HopCount":{
            "description":"Hop Count",
            "type":"integer",
            "example":1
        },
        "LineSize":{
            "description":"Width of the edge.",
            "type":"integer",
            "example":1
        },
        "Stroke":{
            "description":"Line Style",
            "type":"string",
            "example":"Solid"
        },
        "Type":{
            "description":"Edge Type",
            "type":"string",
            "example":"ConnectsLayer2"
        },
        "TypeDirection":{
            "description":"Indicator of the edge tip style. Directional indicates the edge has an arrow pointing from source to target. Non-Directional indicates the edge has no arrows on the tips.\n\n|Allowed Values:\n|  Non-Directional\n|  Directional",
            "type":"string",
            "example":"Non-Directed"
        },
        "TimestampModified":{
            "description":"Timestamp Modified",
            "type":"string",
            "example":"2023-09-05 06:00:18"
        },
        "id":{
            "description":"Edge ID",
            "type":"string",
            "example":"c59a9d9e-b610-4a9e-bfec-eb522a218fe8,1c730895-8505-43a9-ac8e-f18c75edcde9,984921d9-35cc-4571-acc9-6158004c7e53_c59a9d9e-b610-4a9e-bfec-eb522a218fe8_1c730895-8505-43a9-ac8e-f18c75edcde9"
        },
        "EdgeClass":{
            "description":"Edge Class",
            "type":"string",
            "example":"ConnectsLayer2"
        },
        "_type":{
            "description":"Edge Class Type",
            "type":"string",
            "example":"ConnectsLayer2"
        },
        "_id":{
            "description":"Edge Class ID",
            "type":"string",
            "example":"984921d9-35cc-4571-acc9-6158004c7e53_c59a9d9e-b610-4a9e-bfec-eb522a218fe8_1c730895-8505-43a9-ac8e-f18c75edcde9"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json-VertexClass
• application/json-EdgeClass

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
  The response body for a successful get operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/graphNodeDetailsReadVertexClass"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

The response body for a successful get operation.

Show Source

• message: string
  The response message.

  Example: Loaded 1 entries
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful get operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/graphNodeDetailsReadVertexClass"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object graphNodeDetailsReadVertexClass

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/graphNodeDetailsReadVertexClass"
    }
}

Nested Schema : graphNodeDetailsReadVertexClass

Type: object

Show Source

• Event: string
  Color indicator for the event status color.

  Example: url(#Gradient1YellowFill)
• id: string
  node or edge id.

  Example: ab0ac728-2939-4377-9664-4032b03e99a4
• Node: string
  Color indicator for the node status color.

  Example: url(#Gradient1GreenFill)
• Performance: string
  Color indicator for the metric status color.

  Example: url(#Gradient1YellowFill)

{
    "properties":{
        "id":{
            "description":"node or edge id.",
            "type":"string",
            "example":"ab0ac728-2939-4377-9664-4032b03e99a4"
        },
        "Node":{
            "description":"Color indicator for the node status color.",
            "type":"string",
            "example":"url(#Gradient1GreenFill)"
        },
        "Performance":{
            "description":"Color indicator for the metric status color.",
            "type":"string",
            "example":"url(#Gradient1YellowFill)"
        },
        "Event":{
            "description":"Color indicator for the event status color.",
            "type":"string",
            "example":"url(#Gradient1YellowFill)"
        }
    },
    "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