Get Topology Menus for Tree Combos
get
/api/topology/Menus/readForTree
Gets topology menus in a format suitable for tree combos. Specify the id query parameter to get the entire tree from root to the menu with the specified ID. Specify the node parameter if you want to get the children for the menu with the specified ID.
Request
Query Parameters
-
id: integer(int32)
The menu ID to get the entire tree for, from the root to the menu with the specified ID.Example:
1
-
node(required): string
The menu ID to get the children for.
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 : topologyMenusReadForTreeNode
Type:
Show Source
object
-
iconCls: string
CSS class for icons.Example:
x-tree-icon-parent
-
leaf: boolean
Leaf Node of the treeExample:
false
-
TopologyMenuID: integer
Topology Menu IDExample:
1
-
TopologyMenuName: string
Display NameExample:
Root
Nested Schema : topologyMenusReadForTreeID
Type:
Show Source
object
-
data: object
data
Contains the next level of data in the same format as this one.
-
depth: integer
Indicator or how many levels deep this menu is. The root will always be 1
-
expanded: boolean
Indicates if the menu should be displayed expanded or collapsed.
-
Lft: integer
Index of the tree menu's left edgeExample:
1
-
path: string
The path to this menu starting with the root.
-
Rgt: integer
Index of the tree menu's right edgeExample:
2
-
TopologyMenuID: integer
Topology Menu IDExample:
1
-
TopologyMenuName: string
Display NameExample:
Root
-
UserGroupID: integer
User group ID
-
UserGroupName: string
User group name
Nested Schema : data
Type:
object
Contains the next level of data in the same format as this one.
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