Get Dashboard Part Configurations
get
/api/dashboard/Dashboards/readParts
Gets dashboard part configurations. Parts is the internal name for the dashboard panel types.
Request
Query Parameters
-
limit: integer(int32)
The number of records to limit results by.Example:
100
-
query: string
A string to search for. This is a primitive filter, generally applied as a filter on a name parameter, but each endpoint implements it differently.Example:
text
-
sort: object
The field and direction to sort results by. You cannot sort by fields that contain a state.
This parameters value uses the following JSON format:
{
"property": "property",
"direction": "direction"
}-
direction(required):
string
Allowed Values:
[ "ASC", "DESC" ]
The direction of the sort.Example:ASC
-
property(required):
string
The field to sort on.Example:
name
-
direction(required):
string
-
start: integer(int32)
The page of results to start from.Default Value:
0
Example:1
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 : type
Type:
Show Source
object
-
data: array
data
The list of dashboard part configurations.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : dashboardDashboardsReadParts
Type:
Show Source
object
-
PanelTypeID: integer
Panel Type IDExample:
17
-
PanelTypeName: string
Panel Type NameExample:
View Config
-
PartDefinition: string
The configuration definition the dashboard needs in order to render the part.Example:
{17: {viewTemplate: {title: "View Config",form: "Config.viewConfigs.crud.view.ConfigsPanelForm",iconCls: "fa-eye",dockedItems: [],items: [{xtype: "configspanelview"}]}}}
-
pkg: string
Assure1 package the part belongs to.Example:
config
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