Create a Dashboard
post
/api/dashboard/Dashboards
Creates a new dashboard.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
DashboardName: string
Dashboard NameExample:
Basic Services Dashboard
-
HideHeader: integer
Indicates if the header should be shown when the dashboard is renderedExample:
0
-
MaxColumns: integer
Maximum number of columns the dashboard will render before wrapping additional panels onto the next rowExample:
4
-
OwnerUserGroupID: integer
Owner User Group IDExample:
0
-
OwnerUserID: integer
Owner User IDExample:
0
-
PanelParams: string
JSON string of parameters relating to the panelExample:
[{"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
Interval in seconds that the dashboard will automatically refresh all panel content. Null indicates the dashboard does not auto refreshExample:
oracle.doceng.json.BetterJsonNull@4d705112
-
Viewers: array
Viewers
List of user groups that can view
Nested Schema : items
Type:
Show Source
object
-
UserGroupID: integer
The user group ID.
-
UserGroupName: string
The user group name.
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.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : dashboardDashboardsRead
Type:
Show Source
object
-
DashboardID: integer
The dashboard ID.Example:
12
-
DashboardName: string
Dashboard NameExample:
Basic Services Dashboard
-
DashboardTypeID: integer
Dashboard Type idExample:
1
-
DashboardTypeName: string
Dashboard Type NameExample:
Basic
-
HideHeader: integer
Indicates if the header should be shown when the dashboard is renderedExample:
0
-
MaxColumns: integer
Maximum number of columns the dashboard will render before wrapping additional panels onto the next rowExample:
4
-
Owner: string
OwnerExample:
[Public to All Users and Groups]
-
OwnerUserGroupID: integer
Owner User Group IDExample:
0
-
OwnerUserID: integer
Owner User IDExample:
0
-
PanelParams: string
JSON string of parameters relating to the panelExample:
[{"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
Interval in seconds that the dashboard will automatically refresh all panel content. Null indicates the dashboard does not auto refreshExample:
oracle.doceng.json.BetterJsonNull@4d705112
-
Viewers: array
Viewers
List of user groups that can view
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