Move or Copy Dashboards to a Different Group
put
/api/dashboard/DashboardGroups/updateDashboards
Moves or copies dashboards to a different group. To move, specify a source group in SourceDashboardGroupID. To copy, do not specify a source group.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Dashboards(required): array
Dashboards
List of Dashboards IDs
-
id(required): integer
The destination dashboard group ID.Example:
28
-
SourceDashboardGroupID: integer
The source dashboard group ID. To move dashboards, specify an ID. To copy dashboards, do not use this parameter.
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
Response
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulUpdateOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Updated record
-
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