Get Topology Vertices and Edges in a Hierarchical Array
get
/api/graph/Graphs/readForDirectionalTree
Gets topology vertices and edges in a hierarchical array.
Request
Query Parameters
-
Hops: integer(int32)
The number of hops (links) to follow.Example:
1
-
StartVertexID: string
The start vertex ID.Example:
b1e9b165-5f05-4e41-8031-e9f7586a88f9
-
StartVertexPath: string
The path to the start vertex.Example:
//Root//Self Monitoring (Manual Thresholds)
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : schema
Match All
Show Source
-
object
SuccessfulGetOperation
The response body for a successful get operation.
-
object
type
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
Nested Schema : type
Type:
Show Source
object
-
data: array
data
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : graphGraphsReadForDirectionalTree
Type:
Show Source
object
-
Edges: array
Edges
Links in the topology graph (HasService, HasMetric, etc).
-
Nodes: array
Nodes
Nodes in the topology graph (Service, ServiceMetric, etc).
Nested Schema : Edges
Type:
array
Links in the topology graph (HasService, HasMetric, etc).
Show Source
Nested Schema : Nodes
Type:
array
Nodes in the topology graph (Service, ServiceMetric, etc).
Show Source
Nested Schema : items
Type:
Show Source
object
-
Properties: object
Properties
Properties for the edge. The properties will depend on the edge type and any custom properties added.
Nested Schema : Properties
Type:
object
Properties for the edge. The properties will depend on the edge type and any custom properties added.
Nested Schema : items
Type:
Show Source
object
-
NodeName: string
Node NameExample:
Self Monitoring (Manual Thresholds)
-
Properties: object
Properties
The node properties. The properties will depend on the node type and any custom properties added.
Nested Schema : Properties
Type:
object
The node properties. The properties will depend on the node type and any custom properties added.
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
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
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.
Nested Schema : items
Type:
object
An error.