Sign in
latestOpenAPI 3.1.0Apache License Version 2.02026-08-17498525913.3 KB

40169ccdec5c

dashboard-controller

Assign dashboard to edge (assignDashboardToEdge)

Creates assignment of an existing dashboard to an instance of The Edge. Assignment works in async way - first, notification event pushed to edge service queue on platform. Second, remote edge service will receive a copy of assignment dashboard (Edge will receive this instantly, if it's currently connected, or once it's going to be connected to platform). Third, once dashboard will be delivered to edge service, it's going to be available for usage on remote edge instance.

Available for users with 'TENANT_ADMIN' authority.

post/api/edge/{edgeId}/dashboard/{dashboardId}

Path parameters

edgeIdstring required
dashboardIdstring required

Response

OK

titlestring required

Title of the dashboard.

imagestring

Thumbnail picture for rendering of the dashboards in a grid view on mobile devices.

mobileHideboolean

Hide dashboard from mobile devices. Useful if the dashboard is not designed for small screens.

mobileOrderinteger

Order on mobile devices. Useful to adjust sorting of the dashboards for mobile applications

{"stackTrail":"components:schemas:JsonNode","oasType":"schema","type":"unknown","description":"A value representing the any type (object or primitive)","example":{}}
namestring

Same as title of the dashboard. Read-only field. Update the 'title' to change the 'name' of the dashboard.

createdTimeinteger

Timestamp of the dashboard creation, in milliseconds

versioninteger

Example response

{
  "configuration": {},
  "id": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "DASHBOARD"
  },
  "createdTime": 1609459200000,
  "tenantId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "TENANT"
  },
  "assignedCustomers": [
    {
      "customerId": {
        "id": "784f394c-42b6-435a-983c-b7beff2784f9",
        "entityType": "CUSTOMER"
      }
    }
  ]
}