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

40169ccdec5c

dashboard-controller

Get dashboards by Dashboard Ids (getDashboardsByIds)

Returns a list of DashboardInfo objects based on the provided ids.

Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.

get/api/dashboards

Query parameters

dashboardIdsstring[] required

A list of dashboard ids, separated by comma ','

Response

OK

createdTimeinteger

Timestamp of the dashboard creation, in milliseconds

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

versioninteger
namestring

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

Example response

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