Retrieve dashboards using a query
POSThttps://demo.openremote.io/api/master/dashboard/query
Retrieve dashboards using a query
Request
Header Parameters
Authorization string
X-Forwarded-Proto string
X-Forwarded-Host string
- application/json
Body
select object
conditions object
idsstring[]
names object[]
userIdsstring[]
realm object
startint32
limitint32
Responses
- default
default response
- application/json
- Schema
- Example (auto)
Schema
- Array [
- ]
idstring
createdOndate-time
realmstring
Possible values: non-empty
and <= 255 characters
versionint64
ownerIdstring
accessstring
Possible values: [PUBLIC
, SHARED
, PRIVATE
]
displayNamestring
Possible values: non-empty
template objectrequired
[
{
"id": "string",
"createdOn": "2024-07-29T15:51:28.071Z",
"realm": "string",
"version": 0,
"ownerId": "string",
"access": "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": {}
}
]
}
}
]
Authorization: oauth2
name: openidtype: oauth2flows: {
"clientCredentials": {
"tokenUrl": "/auth/realms/master/protocol/openid-connect/token",
"refreshUrl": "/auth/realms/master/protocol/openid-connect/token",
"scopes": {
"profile": "profile"
}
},
"authorizationCode": {
"authorizationUrl": "/auth/realms/master/protocol/openid-connect/auth",
"tokenUrl": "/auth/realms/master/protocol/openid-connect/token",
"refreshUrl": "/auth/realms/master/protocol/openid-connect/token",
"scopes": {
"profile": "profile"
}
}
}
- curl
- nodejs
- java
- python
- ruby
- csharp
- go
- php
- powershell
- CURL
curl -L 'https://demo.openremote.io/api/master/dashboard/query' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <token>' \
-d '{
"select": {
"basic": true
},
"conditions": {
"dashboard": {
"access": [
"PUBLIC"
]
},
"asset": {
"access": [
"RESTRICTED"
],
"minAmount": "AT_LEAST_ONE",
"parents": [
{
"id": "string"
}
]
}
},
"ids": [
"string"
],
"names": [
{
"match": "EXACT",
"caseSensitive": true,
"value": "string",
"negate": true
}
],
"userIds": [
"string"
],
"realm": {
"name": "string"
},
"start": 0,
"limit": 0
}'
ResponseClear