Create a Dashboard Group
post
/api/dashboard/DashboardGroups
Creates a new dashboard group.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
DashboardGroupName: string
Dashboard Group NameExample:
Adhoc
-
Dashboards: array
Dashboards
List of Dashboards IDs
-
ParentDashboardGroupID: integer
Dashboard Group Id of ParentExample:
1
-
Remove: boolean
Remove Dashboard from other Dashboard Groups Allowed Values: 0 => FALSE 1 => TRUE
Nested Schema : Dashboards
Type:
array
List of Dashboards IDs
Show Source
Example:
[
27,
28,
39,
29
]
Response
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulAddOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Added record
-
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 properties of the new dashboard group.
-
total: integer
The total number of results regardless of paging.Example:
1
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