REST API for Unified Assurance Core

Get Topology Menus

get

/api/topology/Menus

Gets the list of all topology menus and their attributes that match the specified parameters. If no parameters are specified, all topology menus and their attributes are returned.

Request

Query Parameters

node: string

The node to the tree.

sort: object

The field and direction to sort results by. You cannot sort by fields that contain a state.
This parameters value uses the following JSON format: { "property": "property", "direction": "direction" }

direction(required): string

Allowed Values: [ "ASC", "DESC" ]

The direction of the sort.

Example: ASC
property(required): string

The field to sort on.

Example: name

{
    "required":[
        "property",
        "direction"
    ],
    "properties":{
        "property":{
            "description":"The field to sort on.",
            "type":"string",
            "example":"name"
        },
        "direction":{
            "description":"The direction of the sort.",
            "type":"string",
            "enum":[
                "ASC",
                "DESC"
            ],
            "example":"ASC"
        }
    },
    "type":"object",
    "example":[
        {
            "property":"Name",
            "direction":"ASC"
        },
        {
            "property":"Value",
            "direction":"DESC"
        }
    ]
}

Example:

[
    {
        "property":"Name",
        "direction":"ASC"
    },
    {
        "property":"Value",
        "direction":"DESC"
    }
]

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

The response body for a successful get operation.
object type

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

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

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

Nested Schema : data

Type: array

Show Source

Array of: object topologyMenusRead

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

Nested Schema : topologyMenusRead

Type: object

Show Source

cls: string

CSS class to indicate if this is a leaf or not

Example: folder
data: array data

Records of data
DisplayName: string

Display Name

Example: Root
expanded: boolean

Expansion of Root Directory

Example: true
id: integer

Topology menu ID

Example: 1
leaf: boolean

Flag to indicate if the menu is the end of the tree (value = true) or the menu has children (value = false)

Example: false
qtip: string

Topology Menu Name

Example: Root
text: string

Topology menu name

Example: Root
TopologyMenuID: integer

Topology Menu ID

Example: 1
TreeDepth: integer

Indicator or how many levels deep the new parent menu is. TreeDepth is different than depth. TreeDepth is the number of menus above the current menu. This means TreeDepth will always be depth - 1.

Example: 1

{
    "properties":{
        "TopologyMenuID":{
            "description":"Topology Menu ID",
            "type":"integer",
            "example":1
        },
        "DisplayName":{
            "description":"Display Name",
            "type":"string",
            "example":"Root"
        },
        "id":{
            "description":"Topology menu ID",
            "type":"integer",
            "example":1
        },
        "TreeDepth":{
            "description":"Indicator or how many levels deep the new parent menu is. TreeDepth is different than depth. TreeDepth is the number of menus above the current menu. This means TreeDepth will always be depth - 1.",
            "type":"integer",
            "example":1
        },
        "text":{
            "description":"Topology menu name",
            "type":"string",
            "example":"Root"
        },
        "leaf":{
            "description":"Flag to indicate if the menu is the end of the tree (value = true) or the menu has children (value = false)",
            "type":"boolean",
            "example":false
        },
        "cls":{
            "description":"CSS class to indicate if this is a leaf or not",
            "type":"string",
            "example":"folder"
        },
        "qtip":{
            "description":"Topology Menu Name",
            "type":"string",
            "example":"Root"
        },
        "expanded":{
            "description":"Expansion of Root Directory",
            "type":"boolean",
            "example":true
        },
        "data":{
            "description":"Records of data",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "TopologyMenuID":{
                        "$ref":"#/components/schemas/topologyMenusRead_byID/properties/TopologyMenuID"
                    },
                    "TopologyMenuName":{
                        "$ref":"#/components/schemas/topologyMenusRead_byID/properties/TopologyMenuName"
                    },
                    "DisplayName":{
                        "$ref":"#/components/schemas/topologyMenusRead/properties/DisplayName"
                    },
                    "ParentMenuID":{
                        "$ref":"#/components/schemas/topologyMenusRead_byID/properties/ParentMenuID"
                    },
                    "qtip":{
                        "$ref":"#/components/schemas/topologyMenusRead/properties/qtip"
                    },
                    "cls":{
                        "description":"Menu type",
                        "type":"string",
                        "example":"folder"
                    }
                }
            },
            "example":[
                {
                    "TopologyMenuID":"2",
                    "TopologyMenuName":"Default Topology Tools",
                    "DisplayName":"Default Topology Tools",
                    "ParentMenuID\"":"1",
                    "qtip":"Default Topology Tools",
                    "cls":"folder"
                },
                {
                    "TopologyMenuID":"1001",
                    "TopologyMenuName":"Sample Topology Tools",
                    "DisplayName":"Sample Topology Tools",
                    "ParentMenuID":"1",
                    "qtip":"Sample Topology Tools",
                    "cls":"folder"
                }
            ]
        }
    },
    "type":"object"
}

Nested Schema : data

Type: array

Records of data

Show Source

Array of: object items

{
    "description":"Records of data",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "TopologyMenuID":{
                "$ref":"#/components/schemas/topologyMenusRead_byID/properties/TopologyMenuID"
            },
            "TopologyMenuName":{
                "$ref":"#/components/schemas/topologyMenusRead_byID/properties/TopologyMenuName"
            },
            "DisplayName":{
                "$ref":"#/components/schemas/topologyMenusRead/properties/DisplayName"
            },
            "ParentMenuID":{
                "$ref":"#/components/schemas/topologyMenusRead_byID/properties/ParentMenuID"
            },
            "qtip":{
                "$ref":"#/components/schemas/topologyMenusRead/properties/qtip"
            },
            "cls":{
                "description":"Menu type",
                "type":"string",
                "example":"folder"
            }
        }
    },
    "example":[
        {
            "TopologyMenuID":"2",
            "TopologyMenuName":"Default Topology Tools",
            "DisplayName":"Default Topology Tools",
            "ParentMenuID\"":"1",
            "qtip":"Default Topology Tools",
            "cls":"folder"
        },
        {
            "TopologyMenuID":"1001",
            "TopologyMenuName":"Sample Topology Tools",
            "DisplayName":"Sample Topology Tools",
            "ParentMenuID":"1",
            "qtip":"Sample Topology Tools",
            "cls":"folder"
        }
    ]
}

Example:

[
    {
        "TopologyMenuID":"2",
        "TopologyMenuName":"Default Topology Tools",
        "DisplayName":"Default Topology Tools",
        "ParentMenuID\"":"1",
        "qtip":"Default Topology Tools",
        "cls":"folder"
    },
    {
        "TopologyMenuID":"1001",
        "TopologyMenuName":"Sample Topology Tools",
        "DisplayName":"Sample Topology Tools",
        "ParentMenuID":"1",
        "qtip":"Sample Topology Tools",
        "cls":"folder"
    }
]

Nested Schema : items

Type: object

Show Source

cls: string

Menu type

Example: folder
DisplayName: string

Display Name

Example: Root
ParentMenuID: integer

Parent Menu ID

Example: 1
qtip: string

Topology Menu Name

Example: Root
TopologyMenuID: integer

Topology Menu ID

Example: 2
TopologyMenuName: string

Topology Menu Name

Example: Default Topology Tools

{
    "type":"object",
    "properties":{
        "TopologyMenuID":{
            "$ref":"#/components/schemas/topologyMenusRead_byID/properties/TopologyMenuID"
        },
        "TopologyMenuName":{
            "$ref":"#/components/schemas/topologyMenusRead_byID/properties/TopologyMenuName"
        },
        "DisplayName":{
            "$ref":"#/components/schemas/topologyMenusRead/properties/DisplayName"
        },
        "ParentMenuID":{
            "$ref":"#/components/schemas/topologyMenusRead_byID/properties/ParentMenuID"
        },
        "qtip":{
            "$ref":"#/components/schemas/topologyMenusRead/properties/qtip"
        },
        "cls":{
            "description":"Menu type",
            "type":"string",
            "example":"folder"
        }
    }
}

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