Get Menus for Diagram Menu
get
/api/diagram/Menus/readForMenu
Returns the constructed list of menus and associated menu tools of a diagram menu.
Request
Query Parameters
-
node: string
The node of the tree to get. It can be either root or DiagramMenuID.
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 : type
Type:
Show Source
object
-
data: array
data
The list of menus.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : diagramMenusReadForMenu
Type:
Show Source
object
- menu: array menu
-
MenuID: integer
Unique identifier for the menuExample:
2
-
MenuName: string
Name of the menuExample:
Device Info
-
ParentMenuID: integer
Menu ID of ParentExample:
1
-
text:
Display name of diagram menuExample:
Device Info
-
UserGroupID: object
UserGroupID
ID of User Group
-
UserGroupName: string
Name associated to the UserGroupIDExample:
Administrators
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