REST API for Unified Assurance Core

Get Topology Vertices and Edges

get

/api/graph/Graphs/read

Gets the topology vertices and edges that match the specified query parameters.

Request

Query Parameters

EndVertexID: string
The end vertex ID.
Example:
```
b1e9b185-5f05-4e41-8031-e9f7586a88f9
```
EndVertexName: string
The end vertex name.
Example:
```
vertex.example.com
```
GraphType(required): string
The graph type. Possible values are:
- VertexList: Get information based on a starting vertex and either an end vertex or a number of hops. Specify the StartVertexID or StartVertexName parameter and the EndVertexID, EndVertexName or Hops parameters.
- VertexProperty: Get information based on a specific vertex property.
- EdgeProperty: Get information based on a specific edge property.
Example:
```
VertexList
```
Hops: integer(int32)
The number of hops (links) to follow.
Example:
```
1
```
Layout(required): string
The layout type.
Example:
```
Tree
```
StartVertexID: string
The start vertex ID.
Example:
```
b1e9b165-5f05-4e41-8031-e9f7586a88f9
```
StartVertexName: string
The start vertex name.
Example:
```
router.example.com
```
StartVertexPath(required): string
The path to the start vertex.
Example:
```
//Root//Self Monitoring (Manual Thresholds)
```
VertexGroupByTypeName:
The group by vertex type name.
Example:
```
Any
```
VertexTuckAwayTypeName:
The tuck away vertex type name.
Example:
```
Interface
```
ViewEdgeTypes: string
The list of edge types to get. Use Any to get all edge types.
Example:
```
Any
```
ViewVertexTypes: array[]
The list of vertex types to get. Use Any to get all vertex types.
Example:
```
Any
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : schema

Match All

Show Source

object SuccessfulGetOperation
object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/graphGraphsRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

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

{
    "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

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/graphGraphsRead"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

Array of: object graphGraphsRead

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

Nested Schema : graphGraphsRead

Type: object

Show Source

Edges: array Edges

Links in the topology graph (ConnectsLayer2, ConnectsInterface, etc)
Nodes: array Nodes

Nodes in the topology graph (device, router, network interface, etc).

{
    "properties":{
        "Nodes":{
            "description":"Nodes in the topology graph (device, router, network interface, etc).",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "Properties":{
                        "description":"Properties for the node. The properties will depend on the node type and any custom properties created. The following is a default device-type node list of properties.",
                        "type":"object",
                        "properties":{
                            "depth":{
                                "description":"Number of hops (links) to follow",
                                "type":"integer",
                                "example":0
                            },
                            "ZoneID":{
                                "description":"Zone ID",
                                "type":"integer",
                                "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":"router.example.com"
                            },
                            "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 should be nested as part of the VertexGroupByTypeName or VertexTuckAwayTypeName selection.",
                                "type":"boolean",
                                "example":true
                            }
                        }
                    },
                    "NodeName":{
                        "description":"Node Name",
                        "type":"string",
                        "example":"router.example.com"
                    }
                }
            }
        },
        "Edges":{
            "description":"Links in the topology graph (ConnectsLayer2, ConnectsInterface, etc)",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "LinkKey":{
                        "description":"Identifier composed of the source node ID and target node ID.",
                        "type":"string",
                        "example":"bbdcf488-37a1-43ea-b892-b3dde946847d,5438f283-07b5-4367-a36b-a8d3ca9b96fd"
                    },
                    "RecordId":{
                        "description":"Identifier composed of edge ID, source node ID, and target node ID.",
                        "type":"string",
                        "example":"4029c7f2-b63d-443c-a855-3b763a16954b_bbdcf488-37a1-43ea-b892-b3dde946847d_5438f283-07b5-4367-a36b-a8d3ca9b96fd"
                    },
                    "Source":{
                        "description":"Name of the source vertex.",
                        "type":"string",
                        "example":"router.example.com"
                    },
                    "Target":{
                        "description":"Name of the target vertex.",
                        "type":"string",
                        "example":"veth2e99c9f"
                    },
                    "Properties":{
                        "description":"Properties for the edge. The properties will depend on the edge type and any custom properties created. The following is a default ConnectsLayer2-type edge list of properties.",
                        "type":"object",
                        "properties":{
                            "HopCount":{
                                "description":"Number of hops from the starting vertex",
                                "type":"integer",
                                "example":1
                            },
                            "LineSize":{
                                "description":"Line size",
                                "type":"integer",
                                "example":1
                            },
                            "Stroke":{
                                "description":"Type of edge pattern. \n\nAllowed Values: \n- Solid\n- Dashed",
                                "type":"string",
                                "example":"Solid"
                            },
                            "TimestampModified":{
                                "description":"Date and time the edge was created or last modified",
                                "type":"string",
                                "example":"2023-04-18T12:34:22.000Z"
                            },
                            "Type":{
                                "description":"The edge type",
                                "type":"string",
                                "example":"HasInterface"
                            },
                            "TypeDirection":{
                                "description":"Describes the arrows on the end of the edge.\n\nAllowed Values:\n- Directed - an arrow on one of the edge pointing to the target\n- Non-Directed - an arrow on both ends of the edge pointing to the source and target",
                                "type":"string",
                                "example":"Non-Directed"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : Edges

Type: array

Links in the topology graph (ConnectsLayer2, ConnectsInterface, etc)

Show Source

Array of: object items

{
    "description":"Links in the topology graph (ConnectsLayer2, ConnectsInterface, etc)",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "LinkKey":{
                "description":"Identifier composed of the source node ID and target node ID.",
                "type":"string",
                "example":"bbdcf488-37a1-43ea-b892-b3dde946847d,5438f283-07b5-4367-a36b-a8d3ca9b96fd"
            },
            "RecordId":{
                "description":"Identifier composed of edge ID, source node ID, and target node ID.",
                "type":"string",
                "example":"4029c7f2-b63d-443c-a855-3b763a16954b_bbdcf488-37a1-43ea-b892-b3dde946847d_5438f283-07b5-4367-a36b-a8d3ca9b96fd"
            },
            "Source":{
                "description":"Name of the source vertex.",
                "type":"string",
                "example":"router.example.com"
            },
            "Target":{
                "description":"Name of the target vertex.",
                "type":"string",
                "example":"veth2e99c9f"
            },
            "Properties":{
                "description":"Properties for the edge. The properties will depend on the edge type and any custom properties created. The following is a default ConnectsLayer2-type edge list of properties.",
                "type":"object",
                "properties":{
                    "HopCount":{
                        "description":"Number of hops from the starting vertex",
                        "type":"integer",
                        "example":1
                    },
                    "LineSize":{
                        "description":"Line size",
                        "type":"integer",
                        "example":1
                    },
                    "Stroke":{
                        "description":"Type of edge pattern. \n\nAllowed Values: \n- Solid\n- Dashed",
                        "type":"string",
                        "example":"Solid"
                    },
                    "TimestampModified":{
                        "description":"Date and time the edge was created or last modified",
                        "type":"string",
                        "example":"2023-04-18T12:34:22.000Z"
                    },
                    "Type":{
                        "description":"The edge type",
                        "type":"string",
                        "example":"HasInterface"
                    },
                    "TypeDirection":{
                        "description":"Describes the arrows on the end of the edge.\n\nAllowed Values:\n- Directed - an arrow on one of the edge pointing to the target\n- Non-Directed - an arrow on both ends of the edge pointing to the source and target",
                        "type":"string",
                        "example":"Non-Directed"
                    }
                }
            }
        }
    }
}

Nested Schema : Nodes

Type: array

Nodes in the topology graph (device, router, network interface, etc).

Show Source

Array of: object items

{
    "description":"Nodes in the topology graph (device, router, network interface, etc).",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "Properties":{
                "description":"Properties for the node. The properties will depend on the node type and any custom properties created. The following is a default device-type node list of properties.",
                "type":"object",
                "properties":{
                    "depth":{
                        "description":"Number of hops (links) to follow",
                        "type":"integer",
                        "example":0
                    },
                    "ZoneID":{
                        "description":"Zone ID",
                        "type":"integer",
                        "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":"router.example.com"
                    },
                    "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 should be nested as part of the VertexGroupByTypeName or VertexTuckAwayTypeName selection.",
                        "type":"boolean",
                        "example":true
                    }
                }
            },
            "NodeName":{
                "description":"Node Name",
                "type":"string",
                "example":"router.example.com"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

LinkKey: string

Identifier composed of the source node ID and target node ID.

Example: bbdcf488-37a1-43ea-b892-b3dde946847d,5438f283-07b5-4367-a36b-a8d3ca9b96fd
Properties: object Properties

Properties for the edge. The properties will depend on the edge type and any custom properties created. The following is a default ConnectsLayer2-type edge list of properties.
RecordId: string

Identifier composed of edge ID, source node ID, and target node ID.

Example: 4029c7f2-b63d-443c-a855-3b763a16954b_bbdcf488-37a1-43ea-b892-b3dde946847d_5438f283-07b5-4367-a36b-a8d3ca9b96fd
Source: string

Name of the source vertex.

Example: router.example.com
Target: string

Name of the target vertex.

Example: veth2e99c9f

{
    "type":"object",
    "properties":{
        "LinkKey":{
            "description":"Identifier composed of the source node ID and target node ID.",
            "type":"string",
            "example":"bbdcf488-37a1-43ea-b892-b3dde946847d,5438f283-07b5-4367-a36b-a8d3ca9b96fd"
        },
        "RecordId":{
            "description":"Identifier composed of edge ID, source node ID, and target node ID.",
            "type":"string",
            "example":"4029c7f2-b63d-443c-a855-3b763a16954b_bbdcf488-37a1-43ea-b892-b3dde946847d_5438f283-07b5-4367-a36b-a8d3ca9b96fd"
        },
        "Source":{
            "description":"Name of the source vertex.",
            "type":"string",
            "example":"router.example.com"
        },
        "Target":{
            "description":"Name of the target vertex.",
            "type":"string",
            "example":"veth2e99c9f"
        },
        "Properties":{
            "description":"Properties for the edge. The properties will depend on the edge type and any custom properties created. The following is a default ConnectsLayer2-type edge list of properties.",
            "type":"object",
            "properties":{
                "HopCount":{
                    "description":"Number of hops from the starting vertex",
                    "type":"integer",
                    "example":1
                },
                "LineSize":{
                    "description":"Line size",
                    "type":"integer",
                    "example":1
                },
                "Stroke":{
                    "description":"Type of edge pattern. \n\nAllowed Values: \n- Solid\n- Dashed",
                    "type":"string",
                    "example":"Solid"
                },
                "TimestampModified":{
                    "description":"Date and time the edge was created or last modified",
                    "type":"string",
                    "example":"2023-04-18T12:34:22.000Z"
                },
                "Type":{
                    "description":"The edge type",
                    "type":"string",
                    "example":"HasInterface"
                },
                "TypeDirection":{
                    "description":"Describes the arrows on the end of the edge.\n\nAllowed Values:\n- Directed - an arrow on one of the edge pointing to the target\n- Non-Directed - an arrow on both ends of the edge pointing to the source and target",
                    "type":"string",
                    "example":"Non-Directed"
                }
            }
        }
    }
}

Nested Schema : Properties

Type: object

Properties for the edge. The properties will depend on the edge type and any custom properties created. The following is a default ConnectsLayer2-type edge list of properties.

Show Source

HopCount: integer

Number of hops from the starting vertex

Example: 1
LineSize: integer

Line size

Example: 1
Stroke: string

Type of edge pattern. Allowed Values: - Solid - Dashed

Example: Solid
TimestampModified: string

Date and time the edge was created or last modified

Example: 2023-04-18T12:34:22.000Z
Type: string

The edge type

Example: HasInterface
TypeDirection: string

Describes the arrows on the end of the edge. Allowed Values: - Directed - an arrow on one of the edge pointing to the target - Non-Directed - an arrow on both ends of the edge pointing to the source and target

Example: Non-Directed

{
    "description":"Properties for the edge. The properties will depend on the edge type and any custom properties created. The following is a default ConnectsLayer2-type edge list of properties.",
    "type":"object",
    "properties":{
        "HopCount":{
            "description":"Number of hops from the starting vertex",
            "type":"integer",
            "example":1
        },
        "LineSize":{
            "description":"Line size",
            "type":"integer",
            "example":1
        },
        "Stroke":{
            "description":"Type of edge pattern. \n\nAllowed Values: \n- Solid\n- Dashed",
            "type":"string",
            "example":"Solid"
        },
        "TimestampModified":{
            "description":"Date and time the edge was created or last modified",
            "type":"string",
            "example":"2023-04-18T12:34:22.000Z"
        },
        "Type":{
            "description":"The edge type",
            "type":"string",
            "example":"HasInterface"
        },
        "TypeDirection":{
            "description":"Describes the arrows on the end of the edge.\n\nAllowed Values:\n- Directed - an arrow on one of the edge pointing to the target\n- Non-Directed - an arrow on both ends of the edge pointing to the source and target",
            "type":"string",
            "example":"Non-Directed"
        }
    }
}

Nested Schema : items

Type: object

Show Source

NodeName: string

Node Name

Example: router.example.com
Properties: object Properties

Properties for the node. The properties will depend on the node type and any custom properties created. The following is a default device-type node list of properties.

{
    "type":"object",
    "properties":{
        "Properties":{
            "description":"Properties for the node. The properties will depend on the node type and any custom properties created. The following is a default device-type node list of properties.",
            "type":"object",
            "properties":{
                "depth":{
                    "description":"Number of hops (links) to follow",
                    "type":"integer",
                    "example":0
                },
                "ZoneID":{
                    "description":"Zone ID",
                    "type":"integer",
                    "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":"router.example.com"
                },
                "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 should be nested as part of the VertexGroupByTypeName or VertexTuckAwayTypeName selection.",
                    "type":"boolean",
                    "example":true
                }
            }
        },
        "NodeName":{
            "description":"Node Name",
            "type":"string",
            "example":"router.example.com"
        }
    }
}

Nested Schema : Properties

Type: object

Properties for the node. The properties will depend on the node type and any custom properties created. The following is a default device-type node list of properties.

Show Source

depth: integer

Number of hops (links) to follow

Example: 0
DeviceID: integer

Device ID

Example: 349
Group: boolean

To check the node should be nested as part of the VertexGroupByTypeName or VertexTuckAwayTypeName selection.

Example: true
IPAddress: string

IP Address

Example: 100.77.220.52
Name: string

Name of the node

Example: router.example.com
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.
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: integer

Zone ID

Example: 3

{
    "description":"Properties for the node. The properties will depend on the node type and any custom properties created. The following is a default device-type node list of properties.",
    "type":"object",
    "properties":{
        "depth":{
            "description":"Number of hops (links) to follow",
            "type":"integer",
            "example":0
        },
        "ZoneID":{
            "description":"Zone ID",
            "type":"integer",
            "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":"router.example.com"
        },
        "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 should be nested as part of the VertexGroupByTypeName or VertexTuckAwayTypeName selection.",
            "type":"boolean",
            "example":true
        }
    }
}

Default Response

Failed operation

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