Retrieve dashboards using a query

POST 
https://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
basicboolean
conditions object
dashboard object
accessstring[]
Possible values: [PUBLIC, SHARED, PRIVATE]
asset object
accessstring[]
Possible values: [RESTRICTED, LINKED, REALM]
minAmountstring
Possible values: [AT_LEAST_ONE, ALL, NONE]
parents object[]
Array [
idstring
]
idsstring[]
names object[]
Array [
matchstring
Possible values: [EXACT, BEGIN, END, CONTAINS]
caseSensitiveboolean
valuestring
negateboolean
]
userIdsstring[]
realm object
namestring
startint32
limitint32

Responses

default

default response

application/json

Schema

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
idstring
columnsint32
Possible values: >= 1
maxScreenWidthint32
Possible values: >= 1
refreshIntervalstring
Possible values: [OFF, ONE_MIN, FIVE_MIN, QUARTER, ONE_HOUR]
screenPresets object[]required
Array [
idstring
displayNamestring
Possible values: non-empty
breakpointint32
Possible values: >= 1
scalingPresetstringrequired
Possible values: [WRAP_TO_SINGLE_COLUMN, KEEP_LAYOUT, REDIRECT, BLOCK_DEVICE]
redirectDashboardIdstring
]
widgets object[]
Array [
idstring
displayNamestringrequired
gridItem objectrequired
idstring
xint32
yint32
wint32
Possible values: >= 1
hint32
Possible values: >= 1
minHint32
minWint32
minPixelHint32
minPixelWint32
noResizeboolean
noMoveboolean
lockedboolean
widgetTypeIdstringrequired
widgetConfigobject
]
]

Example (auto)

[
  {
    "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
}'

Request Collapse all

Base URL

https://demo.openremote.io/api/master

Auth

Bearer Token

Parameters

Authorization — header

X-Forwarded-Proto — header

X-Forwarded-Host — header

Body

{
  "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

Click the Send API Request button above and see the response here!