Jump to

• Request
• Response

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 Top

Response

Supported Media Types

• application/json

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/graphGraphsReadForDirectionalTree"
                    }
                }
            }
        }
    ]
}

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/graphGraphsReadForDirectionalTree"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object graphGraphsReadForDirectionalTree

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

Nested Schema : graphGraphsReadForDirectionalTree

Type: object

Show Source

• Edges: array Edges
  Links in the topology graph (HasService, HasMetric, etc).
• Nodes: array Nodes
  Nodes in the topology graph (Service, ServiceMetric, etc).

{
    "properties":{
        "Nodes":{
            "description":"Nodes in the topology graph (Service, ServiceMetric, etc).",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "NodeName":{
                        "description":"Node Name",
                        "type":"string",
                        "example":"Self Monitoring (Manual Thresholds)"
                    },
                    "Properties":{
                        "description":"The node properties. The properties will depend on the node type and any custom properties added.",
                        "type":"object"
                    }
                }
            }
        },
        "Edges":{
            "description":"Links in the topology graph (HasService, HasMetric, etc).",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "Properties":{
                        "description":"Properties for the edge. The properties will depend on the edge type and any custom properties added.",
                        "type":"object"
                    }
                }
            }
        }
    }
}

Nested Schema : Edges

Type: array

Links in the topology graph (HasService, HasMetric, etc).

Show Source

• Array of: object items

{
    "description":"Links in the topology graph (HasService, HasMetric, etc).",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "Properties":{
                "description":"Properties for the edge. The properties will depend on the edge type and any custom properties added.",
                "type":"object"
            }
        }
    }
}

Nested Schema : Nodes

Type: array

Nodes in the topology graph (Service, ServiceMetric, etc).

Show Source

• Array of: object items

{
    "description":"Nodes in the topology graph (Service, ServiceMetric, etc).",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "NodeName":{
                "description":"Node Name",
                "type":"string",
                "example":"Self Monitoring (Manual Thresholds)"
            },
            "Properties":{
                "description":"The node properties. The properties will depend on the node type and any custom properties added.",
                "type":"object"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• Properties: object Properties
  Properties for the edge. The properties will depend on the edge type and any custom properties added.

{
    "type":"object",
    "properties":{
        "Properties":{
            "description":"Properties for the edge. The properties will depend on the edge type and any custom properties added.",
            "type":"object"
        }
    }
}

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: object

Show Source

• NodeName: string
  Node Name

  Example: Self Monitoring (Manual Thresholds)
• Properties: object Properties
  The node properties. The properties will depend on the node type and any custom properties added.

{
    "type":"object",
    "properties":{
        "NodeName":{
            "description":"Node Name",
            "type":"string",
            "example":"Self Monitoring (Manual Thresholds)"
        },
        "Properties":{
            "description":"The node properties. The properties will depend on the node type and any custom properties added.",
            "type":"object"
        }
    }
}

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

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