Skip to main content
Version: Next

Dashboard

idstring
createdOndate-time
realmstringrequired

Possible values: non-empty and <= 255 characters

versionint64
ownerIdstring
viewAccessstring

Possible values: [PUBLIC, SHARED, PRIVATE]

editAccessstring

Possible values: [PUBLIC, SHARED, PRIVATE]

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