Get a JSON String Representation of a Dashboard
get
/api/dashboard/Dashboards/readExportDashboard
Gets the JSON string representation of the dashboard that matches the specified ID.
Request
Query Parameters
-
DashboardID(required): integer
The dashboard ID required for the export.Example:
26
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : schema
Type:
object
The JSON file to be saved.
Show Source
-
DashboardName: string
The dashboard name.Example:
Basic Services Dashboard
-
DashboardTypeID: integer
The dashboard type ID. Allowed values are: - 1 = Basic - 2 = AdhocExample:
1
-
HideHeader: integer
Indicates if the header should be shown when the dashboard is rendered.Example:
0
-
MaxColumns: integer
The maximum number of columns the dashboard will render before wrapping additional panels onto the next row.Example:
4
-
OwnerUserGroupID: integer
The UserGroupID of the dashboard owner.Example:
0
-
OwnerUserID: integer
The UserID of the dashboard owner.Example:
0
-
PanelParams: string
The configuration information for the dashboard panels.Example:
[{"PartTypeID":"6","width":100,"DashboardName":"Basic Services Dashboard","InitialExpansion":"0","InitialExpansionDynamic":"1","InitialView":"Summary","InitialViewDynamic":"1","LinkTarget":"NewWindow","LinkTargetDynamic":"1","PanelName":"Test","PartTypeID":"6","RefreshRate":"","RootID":"root","RootIDDynamic":"1","ShowToolbar":"1","SummaryInitialExpansion":"all","SummaryInitialExpansionDynamic":"1","SummaryNodeSize":"Normal","SummaryNodeSizeDynamic":"1","SummaryTreeType":"LeftToRight","SummaryTreeTypeDynamic":"1","TimeRangeDynamic":"1","TimeRange":"now-24h..now..","Width":"1","recordID":"DashboardsDashboard","width":"1","AutoHeight":1}]
-
ReloadRate: integer
The time interval in seconds in which the dashboard will automatically refresh all panel content. Null indicates the dashboard does not auto refresh.Example:
oracle.doceng.json.BetterJsonNull@7f3fc42f
-
Viewers: array
Viewers
The list of user groups that can view the dashboard.
Nested Schema : Viewers
Type:
array
The list of user groups that can view the dashboard.
Show Source
Nested Schema : items
Type:
Show Source
object
-
UserGroupID: integer
The user group ID.
-
UserGroupName: string
The user group 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