Retrieve a dashboard

GET 
/dashboard/:realm/:dashboardId

Retrieve a dashboard

Request

Path Parameters

realm stringrequired
dashboardId stringrequired

Header Parameters

Authorization string
X-Forwarded-Proto string
X-Forwarded-Host string

Responses

default

default response

application/json

Schema

Schema

id string
createdOn date-time
realm stringrequired

Possible values: non-empty and <= 255 characters

version int64
ownerId string
viewAccess string

Possible values: [PUBLIC, SHARED, PRIVATE]

editAccess string

Possible values: [PUBLIC, SHARED, PRIVATE]

displayName stringrequired

template

object

required

id string

columns int32

Possible values: >= 1

maxScreenWidth int32

Possible values: >= 1

refreshInterval string

Possible values: [OFF, ONE_MIN, FIVE_MIN, QUARTER, ONE_HOUR]

screenPresets

object[]

required

Array [

id string

displayName stringrequired

breakpoint int32

Possible values: >= 1

scalingPreset stringrequired

Possible values: [WRAP_TO_SINGLE_COLUMN, KEEP_LAYOUT, REDIRECT, BLOCK_DEVICE]

redirectDashboardId string

]

widgets

object[]

Array [

id string

displayName stringrequired

gridItem

object

required

id string

x int32

y int32

w int32

Possible values: >= 1

h int32

Possible values: >= 1

minH int32

minW int32

minPixelH int32

minPixelW int32

noResize boolean

noMove boolean

locked boolean

widgetTypeId stringrequired

widgetConfig object

]

Example (from schema)

{
  "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": {}
      }
    ]
  }
}

Loading...