Get Dashboard Groups for Tree Grids
get
/api/dashboard/DashboardGroups/readForTree
Gets the dashboard groups in a format suitable for tree grids.
Request
Query Parameters
-
node(required): string
The node of the tree to get. You can specify root or the numerical ID.Example:
root
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 dashboard groups.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : dashboardDashboardGroupsReadForTree
Type:
Show Source
object
-
DashboardGroupID: integer
Dashboard Group IDExample:
1
-
DashboardGroupName: string
Dashboard Group NameExample:
Root
-
iconCls: string
CSS class for icons.Example:
x-tree-icon-parent
-
leaf: boolean
Leaf or notExample:
false
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