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(required): 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
-
direction(required):
string
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulGetOperation
Type:
Show Source
object
-
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 : topologyMenusRead
Type:
Show Source
object
-
cls: string
CSS class to indicate if this is a leaf or notExample:
folder
-
data: array
data
Records of data
-
DisplayName: string
Display NameExample:
Root
-
expanded: boolean
Expansion of Root DirectoryExample:
true
-
id: integer
Topology menu IDExample:
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 NameExample:
Root
-
text: string
Topology menu nameExample:
Root
-
TopologyMenuID: integer
Topology Menu IDExample:
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
Nested Schema : data
Type:
array
Records of data
Show Source
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:
Show Source
object
-
cls: string
Menu typeExample:
folder
-
DisplayName: string
Display NameExample:
Root
-
ParentMenuID: integer
Parent Menu IDExample:
1
-
qtip: string
Topology Menu NameExample:
Root
-
TopologyMenuID: integer
Topology Menu IDExample:
2
-
TopologyMenuName: string
Topology Menu NameExample:
Default Topology Tools
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
Nested Schema : items
Type:
object