Get a Topology Menu by ID
get
/api/topology/Menus/{id}
Gets the topology menu that matches the specified ID.
Request
Path Parameters
-
id(required): integer(int32)
The menu ID.Example:
1
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_byID
Type:
Show Source
object
-
ParentMenuID: integer
Parent Menu IDExample:
1
-
Tools: array
Tools
List of Tool IDs
-
TopologyMenuID: integer
Topology Menu IDExample:
2
-
TopologyMenuName: string
Topology Menu NameExample:
Default Topology Tools
-
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.
-
UserGroupID: object
UserGroupID
User Group ID
Nested Schema : Tools
Type:
array
List of Tool IDs
Show Source
Example:
[
{
"ToolID":"1",
"ToolName":"Device Overview"
},
{
"ToolID":"2",
"ToolName":"Events"
}
]
Nested Schema : UserGroupID
Type:
object
User Group ID
Show Source
-
id: integer
ID of the User GroupExample:
1
-
name: string
User Group NameExample:
Administrators
Nested Schema : items
Type:
Show Source
object
-
ToolID: integer
Tool IDExample:
1
-
ToolName: string
Tool NameExample:
Device Overview
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