Get a Diagram Menu by ID
get
/api/diagram/Menus/{id}
Gets the diagram menu that matches the specified ID.
Request
Path Parameters
-
id(required): integer
The diagram menu ID specified for individual CRUD operations.Example:
2
Query Parameters
-
readChildren: boolean
Allowed values - true -> Returns only children menu group information (for tree display). - false -> Returns children menus and menu tools details associated with the diagram menu (for form display).Example:
false
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 : diagramMenusReadByID
Type:
Show Source
object
-
MenuName: string
Name of the menuExample:
Device Info
-
ParentMenuID: integer
Menu ID of ParentExample:
1
-
Tools: object
Tools
List of tool IDs
-
UserGroupID: object
UserGroupID
ID of User Group
Nested Schema : Tools
Type:
object
List of tool IDs
Show Source
-
ToolID: integer
Tool IDExample:
2
-
ToolName: string
Tool NameExample:
Device Health
Example:
[
{
"ToolID":"2",
"ToolName":"Device Health"
},
{
"ToolID":"1",
"ToolName":"Manage Device"
},
{
"ToolID":"3",
"ToolName":"Network Details"
}
]
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