Get Dashboard Groups for Tree Grids or Form Grids
get
/api/dashboard/DashboardGroups
Gets the dashboard groups for the tree grid or the form grid.
Request
Query Parameters
-
node(required): string
The node of the tree to get. You can specify root or the numerical ID.Example:
root
-
sort: object
The field and direction to sort results by. You cannot sort by fields that contain a state.
This parameters value uses the following JSON format:
{
"property": "property",
"direction": "direction"
}-
direction(required):
string
Allowed Values:
[ "ASC", "DESC" ]
The direction of the sort.Example:ASC
-
property(required):
string
The field to sort on.Example:
name
-
direction(required):
string
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 : dashboardDashboardGroupsRead
Type:
Show Source
object
-
cls: string
Example:
folder
-
DashboardGroupID: integer
Dashboard Group IDExample:
1
-
DashboardGroupName: string
Dashboard Group NameExample:
Root
-
data: array
data
List of children Dashboard Group
-
ParentDashboardGroupID: integer
Dashboard Group Id of ParentExample:
1
-
total: integer
Total number of childrenExample:
1
Nested Schema : data
Type:
array
List of children Dashboard Group
Show Source
Example:
[
{
"DashboardGroupID":"1000",
"DashboardGroupName":"Adhoc",
"ParentDashboardGroupID":"1",
"cls":"folder"
}
]
Nested Schema : items
Type:
object
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