Get a Dashboard Group by ID
get
/api/dashboard/DashboardGroups/{id}
Gets the dashboard group that matches the specified ID.
Request
Path Parameters
-
id(required): integer(int32)
The dashboard group ID.
Query Parameters
-
readChildren: boolean
Whether to show tree display or form display. Allowed values - true -> Returns only children group information (for tree display). - false -> Returns the requested group information (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 : dashboardDashboardGroupsReadByID
Type:
Show Source
object
-
DashboardGroupID: integer
Dashboard Group IDExample:
1
-
DashboardGroupName: string
Dashboard Group NameExample:
Adhoc
-
Dashboards: array
Dashboards
List of Dashboards IDs
-
ParentDashboardGroupID: integer
Dashboard Group Id of ParentExample:
1
Nested Schema : Dashboards
Type:
array
List of Dashboards IDs
Show Source
Example:
[
{
"DashboardID":"27",
"DashboardName":"Adhoc Metric Dashboard"
},
{
"DashboardID":"28",
"DashboardName":"Adhoc Event Dashboard"
},
{
"DashboardID":"39",
"DashboardName":"Adhoc View Config Dashboard"
},
{
"DashboardID":"29",
"DashboardName":"Adhoc Graph Dashboard"
}
]
Nested Schema : items
Type:
Show Source
object
-
DashboardID: integer
The dashboard ID.
-
DashboardName: string
Dashboard Name
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