latestOpenAPI 3.1.0Apache License Version 2.02026-08-17498525913.3 KB

40169ccdec5c

dashboard-controller

Get Dashboard (getDashboardById)

Get the dashboard based on 'dashboardId' parameter. The Dashboard object is a heavyweight object that contains information about the dashboard (e.g. title, image, assigned customers) and also configuration JSON (e.g. layouts, widgets, entity aliases).

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

get/api/dashboard/{dashboardId}

Path parameters

dashboardIdstring required

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

Query parameters

includeResourcesboolean

Export used resources and replace resource links with resource metadata

Headers

Accept-Encodingstring

Response

OK