Retrieve dashboards using a query
POST/dashboard/query
Retrieve dashboards using a query
Request
Header Parameters
- application/json
Body
Array [
]
Array [
]
select
object
conditions
object
dashboard
object
Possible values: [PUBLIC
, SHARED
, PRIVATE
]
Possible values: [PUBLIC
, SHARED
, PRIVATE
]
asset
object
Possible values: [RESTRICTED
, LINKED
, REALM
]
Possible values: [AT_LEAST_ONE
, ALL
, NONE
]
parents
object[]
names
object[]
Possible values: [EXACT
, BEGIN
, END
, CONTAINS
]
realm
object
Responses
- default
default response
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
Array [
]
]
Possible values: non-empty
and <= 255 characters
Possible values: [PUBLIC
, SHARED
, PRIVATE
]
Possible values: [PUBLIC
, SHARED
, PRIVATE
]
template
object
required
Possible values: >= 1
Possible values: >= 1
Possible values: [OFF
, ONE_MIN
, FIVE_MIN
, QUARTER
, ONE_HOUR
]
screenPresets
object[]
required
Possible values: >= 1
Possible values: [WRAP_TO_SINGLE_COLUMN
, KEEP_LAYOUT
, REDIRECT
, BLOCK_DEVICE
]
widgets
object[]
gridItem
object
required
Possible values: >= 1
Possible values: >= 1
[
{
"id": "string",
"createdOn": "2024-07-29T15:51:28.071Z",
"realm": "string",
"version": 0,
"ownerId": "string",
"viewAccess": "PUBLIC",
"editAccess": "PUBLIC",
"displayName": "string",
"template": {
"id": "string",
"columns": 0,
"maxScreenWidth": 0,
"refreshInterval": "OFF",
"screenPresets": [
{
"id": "string",
"displayName": "string",
"breakpoint": 0,
"scalingPreset": "WRAP_TO_SINGLE_COLUMN",
"redirectDashboardId": "string"
}
],
"widgets": [
{
"id": "string",
"displayName": "string",
"gridItem": {
"id": "string",
"x": 0,
"y": 0,
"w": 0,
"h": 0,
"minH": 0,
"minW": 0,
"minPixelH": 0,
"minPixelW": 0,
"noResize": true,
"noMove": true,
"locked": true
},
"widgetTypeId": "string",
"widgetConfig": {}
}
]
}
}
]