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

40169ccdec5c

dashboard-controller

Get Tenant Dashboards by System Administrator (getTenantDashboards)

Returns a page of dashboard info objects owned by tenant. The Dashboard Info object contains lightweight information about the dashboard (e.g. title, image, assigned customers) but does not contain the heavyweight configuration JSON. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details.

Available for users with 'SYS_ADMIN' authority.

get/api/tenant/{tenantId}/dashboards

Path parameters

tenantIdstring required

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

Query parameters

pageSizeinteger required

Maximum amount of entities in a one page

pageinteger required

Sequence number of page starting from 0

textSearchstring

The case insensitive 'substring' filter based on the dashboard title.

sortProperty'createdTime' | 'title'

Property of entity to sort by

sortOrder'ASC' | 'DESC'

Sort order. ASC (ASCENDING) or DESC (DESCENDING)

Response

OK

totalPagesinteger

Total number of available pages. Calculated based on the 'pageSize' request parameter and total number of entities that match search criteria

totalElementsinteger

Total number of elements in all available pages

hasNextboolean

'false' value indicates the end of the result set

Example response

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