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

40169ccdec5c

dashboard-controller

Assign the Dashboard to Public Customer (assignDashboardToPublicCustomer)

Assigns the dashboard to a special, auto-generated 'Public' Customer. Once assigned, unauthenticated users may browse the dashboard. This method is useful if you like to embed the dashboard on public web pages to be available for users that are not logged in. Be aware that making the dashboard public does not mean that it automatically makes all devices and assets you use in the dashboard to be public.Use assign Asset to Public Customer and assign Device to Public Customer for this purpose. Returns the Dashboard object.

Available for users with 'TENANT_ADMIN' authority.

post/api/customer/public/dashboard/{dashboardId}

Path parameters

dashboardIdstring required

A string value representing the dashboard id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'

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