{ "info": { "_postman_id": "21954344-d232-4612-b62f-b07aedb86186", "name": "ThingsBoard Admin admin-controller dashboard-controller API", "description": "ThingsBoard Admin API \u2014 subset of the ThingsBoard REST API (open-source IoT platform). Covers: Admin, Audit Log, Event, Usage Info, Queue, Queue Stats, Mail Config Template, Qr Code Settings, Job.\n\nContact Support:\n Name: ThingsBoard team\n Email: info@thingsboard.io", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "lastUpdatedBy": "35240", "uid": "35240-21954344-d232-4612-b62f-b07aedb86186" }, "item": [ { "name": "api", "item": [ { "name": "tenant", "item": [ { "name": "dashboard", "item": [ { "name": "home", "item": [ { "name": "info", "item": [ { "name": "Get Tenant Home Dashboard Info (getTenantHomeDashboardInfo)", "id": "e730776c-0e3a-4dd5-80fb-afc28f6bf618", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/tenant/dashboard/home/info", "host": [ "{{baseUrl}}" ], "path": [ "api", "tenant", "dashboard", "home", "info" ] }, "description": "Returns the home dashboard info object that is configured as 'homeDashboardId' parameter in the 'additionalInfo' of the corresponding tenant. \n\nAvailable for users with 'TENANT_ADMIN' authority." }, "response": [ { "id": "be08f47d-23b3-4d46-9236-d8bd1dabfa5c", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/tenant/dashboard/home/info", "host": [ "{{baseUrl}}" ], "path": [ "api", "tenant", "dashboard", "home", "info" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"dashboardId\": {\n \"entityType\": \"DASHBOARD\",\n \"id\": \"\"\n },\n \"hideDashboardToolbar\": \"\"\n}", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-be08f47d-23b3-4d46-9236-d8bd1dabfa5c" } ], "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-e730776c-0e3a-4dd5-80fb-afc28f6bf618" }, { "name": "Update Tenant Home Dashboard Info (getTenantHomeDashboardInfo)", "id": "524f7890-ea95-4379-a399-4a3698348144", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dashboardId\": {\n \"entityType\": \"DASHBOARD\",\n \"id\": \"\"\n },\n \"hideDashboardToolbar\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/tenant/dashboard/home/info", "host": [ "{{baseUrl}}" ], "path": [ "api", "tenant", "dashboard", "home", "info" ] }, "description": "Update the home dashboard assignment for the current tenant. \n\nAvailable for users with 'TENANT_ADMIN' authority." }, "response": [ { "id": "9816df3b-1e0b-49e1-a153-352a57ce86f4", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dashboardId\": {\n \"entityType\": \"DASHBOARD\",\n \"id\": \"\"\n },\n \"hideDashboardToolbar\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/tenant/dashboard/home/info", "host": [ "{{baseUrl}}" ], "path": [ "api", "tenant", "dashboard", "home", "info" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-9816df3b-1e0b-49e1-a153-352a57ce86f4" } ], "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-524f7890-ea95-4379-a399-4a3698348144" } ], "id": "bb7e547a-e14d-4be2-9ef5-17d64a9003e9", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-bb7e547a-e14d-4be2-9ef5-17d64a9003e9" } ], "id": "85841a1e-05fb-4e7e-be5b-dfb7efc43cd8", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-85841a1e-05fb-4e7e-be5b-dfb7efc43cd8" } ], "id": "f7037da8-e3c9-4e44-b637-98b478935d72", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-f7037da8-e3c9-4e44-b637-98b478935d72" }, { "name": "{tenantId}", "item": [ { "name": "dashboards", "item": [ { "name": "Get Tenant Dashboards by System Administrator (getTenantDashboards)", "id": "70cfd5af-e97c-47e0-9dc8-59284b5ab025", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/tenant/:tenantId/dashboards?pageSize=&page=&textSearch=&sortProperty=title&sortOrder=ASC", "host": [ "{{baseUrl}}" ], "path": [ "api", "tenant", ":tenantId", "dashboards" ], "query": [ { "description": "(Required) Maximum amount of entities in a one page", "key": "pageSize", "value": "" }, { "description": "(Required) Sequence number of page starting from 0", "key": "page", "value": "" }, { "description": "The case insensitive 'substring' filter based on the dashboard title.", "key": "textSearch", "value": "" }, { "description": "Property of entity to sort by", "key": "sortProperty", "value": "title" }, { "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)", "key": "sortOrder", "value": "ASC" } ], "variable": [ { "id": "242bc85c-cfc4-4ca1-8197-29dfa34c71a0", "key": "tenantId", "value": "", "description": "(Required) A string value representing the tenant id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "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. \n\nAvailable for users with 'SYS_ADMIN' authority." }, "response": [ { "id": "39c15278-aace-4210-ab79-593c1d32c825", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/tenant/:tenantId/dashboards?pageSize=&page=&textSearch=&sortProperty=title&sortOrder=ASC", "host": [ "{{baseUrl}}" ], "path": [ "api", "tenant", ":tenantId", "dashboards" ], "query": [ { "description": "(Required) Maximum amount of entities in a one page", "key": "pageSize", "value": "" }, { "description": "(Required) Sequence number of page starting from 0", "key": "page", "value": "" }, { "description": "The case insensitive 'substring' filter based on the dashboard title.", "key": "textSearch", "value": "" }, { "description": "Property of entity to sort by", "key": "sortProperty", "value": "title" }, { "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)", "key": "sortOrder", "value": "ASC" } ], "variable": [ { "key": "tenantId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"title\": \"\",\n \"id\": {\n \"entityType\": \"DASHBOARD\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"image\": \"\",\n \"assignedCustomers\": [\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n },\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n }\n ],\n \"mobileHide\": \"\",\n \"mobileOrder\": \"\",\n \"version\": \"\",\n \"name\": \"\"\n },\n {\n \"title\": \"\",\n \"id\": {\n \"entityType\": \"DASHBOARD\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"image\": \"\",\n \"assignedCustomers\": [\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n },\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n }\n ],\n \"mobileHide\": \"\",\n \"mobileOrder\": \"\",\n \"version\": \"\",\n \"name\": \"\"\n }\n ],\n \"totalPages\": \"\",\n \"totalElements\": \"\",\n \"hasNext\": \"\"\n}", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-39c15278-aace-4210-ab79-593c1d32c825" } ], "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-70cfd5af-e97c-47e0-9dc8-59284b5ab025" } ], "id": "d449d287-c957-4e26-97b1-7dcd6084cec7", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-d449d287-c957-4e26-97b1-7dcd6084cec7" } ], "id": "c0c24d9c-68de-4dd5-9bfb-4e0d741819f0", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-c0c24d9c-68de-4dd5-9bfb-4e0d741819f0" }, { "name": "dashboards", "item": [ { "name": "Get Tenant Dashboards (getTenantDashboards)", "id": "1789049e-253e-4079-8e0a-9b8f572800e9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/tenant/dashboards?pageSize=&page=&mobile=&textSearch=&sortProperty=title&sortOrder=ASC", "host": [ "{{baseUrl}}" ], "path": [ "api", "tenant", "dashboards" ], "query": [ { "description": "(Required) Maximum amount of entities in a one page", "key": "pageSize", "value": "" }, { "description": "(Required) Sequence number of page starting from 0", "key": "page", "value": "" }, { "description": "Exclude dashboards that are hidden for mobile", "key": "mobile", "value": "" }, { "description": "The case insensitive 'substring' filter based on the dashboard title.", "key": "textSearch", "value": "" }, { "description": "Property of entity to sort by", "key": "sortProperty", "value": "title" }, { "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)", "key": "sortOrder", "value": "ASC" } ] }, "description": "Returns a page of dashboard info objects owned by the tenant of a current user. 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. \n\nAvailable for users with 'TENANT_ADMIN' authority." }, "response": [ { "id": "c325741c-39ea-4b81-9b3d-1cd81afbb34e", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/tenant/dashboards?pageSize=&page=&mobile=&textSearch=&sortProperty=title&sortOrder=ASC", "host": [ "{{baseUrl}}" ], "path": [ "api", "tenant", "dashboards" ], "query": [ { "description": "(Required) Maximum amount of entities in a one page", "key": "pageSize", "value": "" }, { "description": "(Required) Sequence number of page starting from 0", "key": "page", "value": "" }, { "description": "Exclude dashboards that are hidden for mobile", "key": "mobile", "value": "" }, { "description": "The case insensitive 'substring' filter based on the dashboard title.", "key": "textSearch", "value": "" }, { "description": "Property of entity to sort by", "key": "sortProperty", "value": "title" }, { "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)", "key": "sortOrder", "value": "ASC" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"title\": \"\",\n \"id\": {\n \"entityType\": \"DASHBOARD\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"image\": \"\",\n \"assignedCustomers\": [\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n },\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n }\n ],\n \"mobileHide\": \"\",\n \"mobileOrder\": \"\",\n \"version\": \"\",\n \"name\": \"\"\n },\n {\n \"title\": \"\",\n \"id\": {\n \"entityType\": \"DASHBOARD\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"image\": \"\",\n \"assignedCustomers\": [\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n },\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n }\n ],\n \"mobileHide\": \"\",\n \"mobileOrder\": \"\",\n \"version\": \"\",\n \"name\": \"\"\n }\n ],\n \"totalPages\": \"\",\n \"totalElements\": \"\",\n \"hasNext\": \"\"\n}", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-c325741c-39ea-4b81-9b3d-1cd81afbb34e" } ], "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-1789049e-253e-4079-8e0a-9b8f572800e9" } ], "id": "3e6b865b-8d6f-4d4b-9424-67405a89ba52", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-3e6b865b-8d6f-4d4b-9424-67405a89ba52" } ], "id": "a02d949d-b3f3-4c80-8d85-3cac4763d178", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-a02d949d-b3f3-4c80-8d85-3cac4763d178" }, { "name": "edge", "item": [ { "name": "{edgeId}", "item": [ { "name": "dashboard", "item": [ { "name": "{dashboardId}", "item": [ { "name": "Assign Dashboard to Edge (assignDashboardToEdge)", "id": "9cb85a5c-1eea-4966-a268-4f432171f48e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/edge/:edgeId/dashboard/:dashboardId", "host": [ "{{baseUrl}}" ], "path": [ "api", "edge", ":edgeId", "dashboard", ":dashboardId" ], "variable": [ { "id": "c44509d6-e955-40a7-89ef-37a44e607166", "key": "edgeId", "value": "", "description": "(Required) " }, { "id": "ec7e79b8-51c8-44d2-804e-fa30abf26f51", "key": "dashboardId", "value": "", "description": "(Required) " } ] }, "description": "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.\n\nAvailable for users with 'TENANT_ADMIN' authority." }, "response": [ { "id": "448b0abd-7d1c-465c-b524-e894d388fdd5", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/edge/:edgeId/dashboard/:dashboardId", "host": [ "{{baseUrl}}" ], "path": [ "api", "edge", ":edgeId", "dashboard", ":dashboardId" ], "variable": [ { "key": "edgeId" }, { "key": "dashboardId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"title\": \"\",\n \"image\": \"\",\n \"mobileHide\": \"\",\n \"mobileOrder\": \"\",\n \"configuration\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"name\": \"\",\n \"resources\": [\n {\n \"link\": \"\",\n \"title\": \"\",\n \"type\": \"DASHBOARD\",\n \"subType\": \"SCADA_SYMBOL\",\n \"resourceKey\": \"\",\n \"fileName\": \"\",\n \"publicResourceKey\": \"\",\n \"isPublic\": \"\",\n \"mediaType\": \"\",\n \"data\": \"\",\n \"public\": \"\"\n },\n {\n \"link\": \"\",\n \"title\": \"\",\n \"type\": \"PKCS_12\",\n \"subType\": \"SCADA_SYMBOL\",\n \"resourceKey\": \"\",\n \"fileName\": \"\",\n \"publicResourceKey\": \"\",\n \"isPublic\": \"\",\n \"mediaType\": \"\",\n \"data\": \"\",\n \"public\": \"\"\n }\n ],\n \"id\": {\n \"entityType\": \"DASHBOARD\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"assignedCustomers\": [\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n },\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n }\n ],\n \"version\": \"\"\n}", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-448b0abd-7d1c-465c-b524-e894d388fdd5" } ], "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-9cb85a5c-1eea-4966-a268-4f432171f48e" }, { "name": "Unassign Dashboard from Edge (unassignDashboardFromEdge)", "id": "a27dcf02-4b0e-4ae0-8959-dddd5a2f5eab", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/edge/:edgeId/dashboard/:dashboardId", "host": [ "{{baseUrl}}" ], "path": [ "api", "edge", ":edgeId", "dashboard", ":dashboardId" ], "variable": [ { "id": "a8f6af46-b78f-44c7-876b-c4fc50cff0b7", "key": "edgeId", "value": "", "description": "(Required) " }, { "id": "6f6e49f1-112c-435c-b519-01f9093fa6be", "key": "dashboardId", "value": "", "description": "(Required) " } ] }, "description": "Clears assignment of the dashboard to the edge. Unassignment works in async way - first, 'unassign' notification event pushed to edge queue on platform. Second, remote edge service will receive an 'unassign' command to remove dashboard (Edge will receive this instantly, if it's currently connected, or once it's going to be connected to platform). Third, once 'unassign' command will be delivered to edge service, it's going to remove dashboard locally.\n\nAvailable for users with 'TENANT_ADMIN' authority." }, "response": [ { "id": "2cba0195-8c69-4211-94f3-36539b1bd75a", "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/edge/:edgeId/dashboard/:dashboardId", "host": [ "{{baseUrl}}" ], "path": [ "api", "edge", ":edgeId", "dashboard", ":dashboardId" ], "variable": [ { "key": "edgeId" }, { "key": "dashboardId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"title\": \"\",\n \"image\": \"\",\n \"mobileHide\": \"\",\n \"mobileOrder\": \"\",\n \"configuration\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"name\": \"\",\n \"resources\": [\n {\n \"link\": \"\",\n \"title\": \"\",\n \"type\": \"DASHBOARD\",\n \"subType\": \"SCADA_SYMBOL\",\n \"resourceKey\": \"\",\n \"fileName\": \"\",\n \"publicResourceKey\": \"\",\n \"isPublic\": \"\",\n \"mediaType\": \"\",\n \"data\": \"\",\n \"public\": \"\"\n },\n {\n \"link\": \"\",\n \"title\": \"\",\n \"type\": \"PKCS_12\",\n \"subType\": \"SCADA_SYMBOL\",\n \"resourceKey\": \"\",\n \"fileName\": \"\",\n \"publicResourceKey\": \"\",\n \"isPublic\": \"\",\n \"mediaType\": \"\",\n \"data\": \"\",\n \"public\": \"\"\n }\n ],\n \"id\": {\n \"entityType\": \"DASHBOARD\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"assignedCustomers\": [\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n },\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n }\n ],\n \"version\": \"\"\n}", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-2cba0195-8c69-4211-94f3-36539b1bd75a" } ], "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-a27dcf02-4b0e-4ae0-8959-dddd5a2f5eab" } ], "id": "f79eb67f-23ea-45fb-82bd-c087f41b8f76", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-f79eb67f-23ea-45fb-82bd-c087f41b8f76" } ], "id": "6a4b4a87-bdab-4680-bfb7-89d88d8e84ac", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-6a4b4a87-bdab-4680-bfb7-89d88d8e84ac" }, { "name": "dashboards", "item": [ { "name": "Get Edge Dashboards (getEdgeDashboards)", "id": "d1723a38-0570-4d10-82e4-f217cb57b512", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/edge/:edgeId/dashboards?pageSize=&page=&textSearch=&sortProperty=title&sortOrder=ASC", "host": [ "{{baseUrl}}" ], "path": [ "api", "edge", ":edgeId", "dashboards" ], "query": [ { "description": "(Required) Maximum amount of entities in a one page", "key": "pageSize", "value": "" }, { "description": "(Required) Sequence number of page starting from 0", "key": "page", "value": "" }, { "description": "The case insensitive 'substring' filter based on the dashboard title.", "key": "textSearch", "value": "" }, { "description": "Property of entity to sort by", "key": "sortProperty", "value": "title" }, { "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)", "key": "sortOrder", "value": "ASC" } ], "variable": [ { "id": "83cd7036-d88c-4c80-bf96-1446dc378c39", "key": "edgeId", "value": "", "description": "(Required) A string value representing the edge id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "Returns a page of dashboard info objects assigned to the specified edge. 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. \n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "eb0ec084-7592-4bff-8030-72a31348abf7", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/edge/:edgeId/dashboards?pageSize=&page=&textSearch=&sortProperty=title&sortOrder=ASC", "host": [ "{{baseUrl}}" ], "path": [ "api", "edge", ":edgeId", "dashboards" ], "query": [ { "description": "(Required) Maximum amount of entities in a one page", "key": "pageSize", "value": "" }, { "description": "(Required) Sequence number of page starting from 0", "key": "page", "value": "" }, { "description": "The case insensitive 'substring' filter based on the dashboard title.", "key": "textSearch", "value": "" }, { "description": "Property of entity to sort by", "key": "sortProperty", "value": "title" }, { "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)", "key": "sortOrder", "value": "ASC" } ], "variable": [ { "key": "edgeId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"title\": \"\",\n \"id\": {\n \"entityType\": \"DASHBOARD\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"image\": \"\",\n \"assignedCustomers\": [\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n },\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n }\n ],\n \"mobileHide\": \"\",\n \"mobileOrder\": \"\",\n \"version\": \"\",\n \"name\": \"\"\n },\n {\n \"title\": \"\",\n \"id\": {\n \"entityType\": \"DASHBOARD\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"image\": \"\",\n \"assignedCustomers\": [\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n },\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n }\n ],\n \"mobileHide\": \"\",\n \"mobileOrder\": \"\",\n \"version\": \"\",\n \"name\": \"\"\n }\n ],\n \"totalPages\": \"\",\n \"totalElements\": \"\",\n \"hasNext\": \"\"\n}", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-eb0ec084-7592-4bff-8030-72a31348abf7" } ], "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-d1723a38-0570-4d10-82e4-f217cb57b512" } ], "id": "d81c2ee2-7056-4e0d-90c3-5b3ce8ead0f7", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-d81c2ee2-7056-4e0d-90c3-5b3ce8ead0f7" } ], "id": "bb12b376-6aaf-46b5-9714-f179b9d96856", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-bb12b376-6aaf-46b5-9714-f179b9d96856" } ], "id": "f6550d5e-1a0e-4606-945f-c7a0c0e7d658", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-f6550d5e-1a0e-4606-945f-c7a0c0e7d658" }, { "name": "dashboard", "item": [ { "name": "{dashboardId}", "item": [ { "name": "customers", "item": [ { "name": "remove", "item": [ { "name": "Remove the Dashboard Customers (removeDashboardCustomers)", "id": "aff798b6-f077-42ed-8aa7-ab9a67c8f0e5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n \"\",\n \"\"\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/dashboard/:dashboardId/customers/remove", "host": [ "{{baseUrl}}" ], "path": [ "api", "dashboard", ":dashboardId", "customers", "remove" ], "variable": [ { "id": "4a56cd27-7bd4-4184-8128-878ef4c9d9af", "key": "dashboardId", "value": "", "description": "(Required) A string value representing the dashboard id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "Removes the list of Customers from the existing list of assignments for the Dashboard. Keeps other assignments to customers that are not in the provided list. Returns the Dashboard object.\n\nAvailable for users with 'TENANT_ADMIN' authority." }, "response": [ { "id": "5c332a7f-4a3f-410e-a66f-197194f96909", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n \"\",\n \"\"\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/dashboard/:dashboardId/customers/remove", "host": [ "{{baseUrl}}" ], "path": [ "api", "dashboard", ":dashboardId", "customers", "remove" ], "variable": [ { "key": "dashboardId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"title\": \"\",\n \"image\": \"\",\n \"mobileHide\": \"\",\n \"mobileOrder\": \"\",\n \"configuration\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"name\": \"\",\n \"resources\": [\n {\n \"link\": \"\",\n \"title\": \"\",\n \"type\": \"DASHBOARD\",\n \"subType\": \"SCADA_SYMBOL\",\n \"resourceKey\": \"\",\n \"fileName\": \"\",\n \"publicResourceKey\": \"\",\n \"isPublic\": \"\",\n \"mediaType\": \"\",\n \"data\": \"\",\n \"public\": \"\"\n },\n {\n \"link\": \"\",\n \"title\": \"\",\n \"type\": \"PKCS_12\",\n \"subType\": \"SCADA_SYMBOL\",\n \"resourceKey\": \"\",\n \"fileName\": \"\",\n \"publicResourceKey\": \"\",\n \"isPublic\": \"\",\n \"mediaType\": \"\",\n \"data\": \"\",\n \"public\": \"\"\n }\n ],\n \"id\": {\n \"entityType\": \"DASHBOARD\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"assignedCustomers\": [\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n },\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n }\n ],\n \"version\": \"\"\n}", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-5c332a7f-4a3f-410e-a66f-197194f96909" } ], "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-aff798b6-f077-42ed-8aa7-ab9a67c8f0e5" } ], "id": "6779fc9c-bb34-4b4a-bd20-29ba706056c1", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-6779fc9c-bb34-4b4a-bd20-29ba706056c1" }, { "name": "add", "item": [ { "name": "Adds the Dashboard Customers (addDashboardCustomers)", "id": "1150e464-e856-448c-9016-967f6cda3c1c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n \"\",\n \"\"\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/dashboard/:dashboardId/customers/add", "host": [ "{{baseUrl}}" ], "path": [ "api", "dashboard", ":dashboardId", "customers", "add" ], "variable": [ { "id": "abf22053-892a-4dce-b0ba-389bbe98b9b4", "key": "dashboardId", "value": "", "description": "(Required) A string value representing the dashboard id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "Adds the list of Customers to the existing list of assignments for the Dashboard. Keeps previous assignments to customers that are not in the provided list. Returns the Dashboard object.\n\nAvailable for users with 'TENANT_ADMIN' authority." }, "response": [ { "id": "fd003122-ff0e-4fb0-b0d2-cc44c4684ac2", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n \"\",\n \"\"\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/dashboard/:dashboardId/customers/add", "host": [ "{{baseUrl}}" ], "path": [ "api", "dashboard", ":dashboardId", "customers", "add" ], "variable": [ { "key": "dashboardId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"title\": \"\",\n \"image\": \"\",\n \"mobileHide\": \"\",\n \"mobileOrder\": \"\",\n \"configuration\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"name\": \"\",\n \"resources\": [\n {\n \"link\": \"\",\n \"title\": \"\",\n \"type\": \"DASHBOARD\",\n \"subType\": \"SCADA_SYMBOL\",\n \"resourceKey\": \"\",\n \"fileName\": \"\",\n \"publicResourceKey\": \"\",\n \"isPublic\": \"\",\n \"mediaType\": \"\",\n \"data\": \"\",\n \"public\": \"\"\n },\n {\n \"link\": \"\",\n \"title\": \"\",\n \"type\": \"PKCS_12\",\n \"subType\": \"SCADA_SYMBOL\",\n \"resourceKey\": \"\",\n \"fileName\": \"\",\n \"publicResourceKey\": \"\",\n \"isPublic\": \"\",\n \"mediaType\": \"\",\n \"data\": \"\",\n \"public\": \"\"\n }\n ],\n \"id\": {\n \"entityType\": \"DASHBOARD\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"assignedCustomers\": [\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n },\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n }\n ],\n \"version\": \"\"\n}", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-fd003122-ff0e-4fb0-b0d2-cc44c4684ac2" } ], "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-1150e464-e856-448c-9016-967f6cda3c1c" } ], "id": "666d0032-ace4-4b3d-be72-aec7e9517ab2", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-666d0032-ace4-4b3d-be72-aec7e9517ab2" }, { "name": "Update the Dashboard Customers (updateDashboardCustomers)", "id": "ecc4c4ba-f53e-4789-8ff8-1698b89a7497", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n \"\",\n \"\"\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/dashboard/:dashboardId/customers", "host": [ "{{baseUrl}}" ], "path": [ "api", "dashboard", ":dashboardId", "customers" ], "variable": [ { "id": "7f18940c-f3fe-416b-91a3-e80b5f193096", "key": "dashboardId", "value": "", "description": "(Required) A string value representing the dashboard id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "Updates the list of Customers that this Dashboard is assigned to. Removes previous assignments to customers that are not in the provided list. Returns the Dashboard object. \n\nAvailable for users with 'TENANT_ADMIN' authority." }, "response": [ { "id": "5f5b9b6d-8baf-4165-b6a2-cc63cd81ba6e", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n \"\",\n \"\"\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/dashboard/:dashboardId/customers", "host": [ "{{baseUrl}}" ], "path": [ "api", "dashboard", ":dashboardId", "customers" ], "variable": [ { "key": "dashboardId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"title\": \"\",\n \"image\": \"\",\n \"mobileHide\": \"\",\n \"mobileOrder\": \"\",\n \"configuration\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"name\": \"\",\n \"resources\": [\n {\n \"link\": \"\",\n \"title\": \"\",\n \"type\": \"DASHBOARD\",\n \"subType\": \"SCADA_SYMBOL\",\n \"resourceKey\": \"\",\n \"fileName\": \"\",\n \"publicResourceKey\": \"\",\n \"isPublic\": \"\",\n \"mediaType\": \"\",\n \"data\": \"\",\n \"public\": \"\"\n },\n {\n \"link\": \"\",\n \"title\": \"\",\n \"type\": \"PKCS_12\",\n \"subType\": \"SCADA_SYMBOL\",\n \"resourceKey\": \"\",\n \"fileName\": \"\",\n \"publicResourceKey\": \"\",\n \"isPublic\": \"\",\n \"mediaType\": \"\",\n \"data\": \"\",\n \"public\": \"\"\n }\n ],\n \"id\": {\n \"entityType\": \"DASHBOARD\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"assignedCustomers\": [\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n },\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n }\n ],\n \"version\": \"\"\n}", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-5f5b9b6d-8baf-4165-b6a2-cc63cd81ba6e" } ], "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-ecc4c4ba-f53e-4789-8ff8-1698b89a7497" } ], "id": "c8061a53-ec02-45be-ae15-9297e9f0af46", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-c8061a53-ec02-45be-ae15-9297e9f0af46" }, { "name": "Get Dashboard (getDashboardById)", "id": "a92b9e60-3a2e-4ed0-ac94-971f21f53dc1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept-Encoding", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/dashboard/:dashboardId?includeResources=", "host": [ "{{baseUrl}}" ], "path": [ "api", "dashboard", ":dashboardId" ], "query": [ { "description": "Export used resources and replace resource links with resource metadata", "key": "includeResources", "value": "" } ], "variable": [ { "id": "6054d9e7-3d3e-4e2b-ae21-0db974531b55", "key": "dashboardId", "value": "", "description": "(Required) A string value representing the dashboard id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "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).\n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "29ceb2c2-a4df-449c-a00d-01f16ca7c5d8", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Encoding", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/dashboard/:dashboardId?includeResources=", "host": [ "{{baseUrl}}" ], "path": [ "api", "dashboard", ":dashboardId" ], "query": [ { "description": "Export used resources and replace resource links with resource metadata", "key": "includeResources", "value": "" } ], "variable": [ { "key": "dashboardId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-29ceb2c2-a4df-449c-a00d-01f16ca7c5d8" } ], "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-a92b9e60-3a2e-4ed0-ac94-971f21f53dc1" }, { "name": "Delete the Dashboard (deleteDashboard)", "id": "ef4668f6-fe59-4281-b953-3187df999701", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/dashboard/:dashboardId", "host": [ "{{baseUrl}}" ], "path": [ "api", "dashboard", ":dashboardId" ], "variable": [ { "id": "9021e8a6-a820-4253-9e71-3e339dae6208", "key": "dashboardId", "value": "", "description": "(Required) A string value representing the dashboard id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "Delete the Dashboard.\n\nAvailable for users with 'TENANT_ADMIN' authority." }, "response": [ { "id": "a4b78fdb-548e-4150-b7e6-81bc11208e15", "name": "OK", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/dashboard/:dashboardId", "host": [ "{{baseUrl}}" ], "path": [ "api", "dashboard", ":dashboardId" ], "variable": [ { "key": "dashboardId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-a4b78fdb-548e-4150-b7e6-81bc11208e15" } ], "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-ef4668f6-fe59-4281-b953-3187df999701" } ], "id": "89e5b825-4805-4a11-924f-b965888753b9", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-89e5b825-4805-4a11-924f-b965888753b9" }, { "name": "serverTime", "item": [ { "name": "Get Server Time (getServerTime)", "id": "3cd4ea06-1fd7-4d52-8079-8ae40f50f82b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/dashboard/serverTime", "host": [ "{{baseUrl}}" ], "path": [ "api", "dashboard", "serverTime" ] }, "description": "Get the server time (milliseconds since January 1, 1970 UTC). Used to adjust view of the dashboards according to the difference between browser and server time." }, "response": [ { "id": "0109cf2d-dda0-4376-b4a9-f1ce98dcb97f", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/dashboard/serverTime", "host": [ "{{baseUrl}}" ], "path": [ "api", "dashboard", "serverTime" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"example\": 1636023857137\n}", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-0109cf2d-dda0-4376-b4a9-f1ce98dcb97f" } ], "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-3cd4ea06-1fd7-4d52-8079-8ae40f50f82b" } ], "id": "3bf72bdc-5be8-4913-ae03-17855efb2785", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-3bf72bdc-5be8-4913-ae03-17855efb2785" }, { "name": "maxDatapointsLimit", "item": [ { "name": "Get Max Data Points Limit (getMaxDatapointsLimit)", "id": "34acd950-6504-4571-ad27-f471a225615e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/dashboard/maxDatapointsLimit", "host": [ "{{baseUrl}}" ], "path": [ "api", "dashboard", "maxDatapointsLimit" ] }, "description": "Get the maximum number of data points that dashboard may request from the server per in a single subscription command. This value impacts the time window behavior. It impacts 'Max values' parameter in case user selects 'None' as 'Data aggregation function'. It also impacts the 'Grouping interval' in case of any other 'Data aggregation function' is selected. The actual value of the limit is configurable in the system configuration file." }, "response": [ { "id": "70e0bd2a-53b0-4514-b95d-15f2b0d4d7f5", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/dashboard/maxDatapointsLimit", "host": [ "{{baseUrl}}" ], "path": [ "api", "dashboard", "maxDatapointsLimit" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"example\": 5000\n}", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-70e0bd2a-53b0-4514-b95d-15f2b0d4d7f5" } ], "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-34acd950-6504-4571-ad27-f471a225615e" } ], "id": "98f39d2f-6453-4d9a-929b-7a72042e49e7", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-98f39d2f-6453-4d9a-929b-7a72042e49e7" }, { "name": "info", "item": [ { "name": "{dashboardId}", "item": [ { "name": "Get Dashboard Info (getDashboardInfoById)", "id": "e8f7f85e-2433-4d49-a269-3a57ba115ea2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/dashboard/info/:dashboardId", "host": [ "{{baseUrl}}" ], "path": [ "api", "dashboard", "info", ":dashboardId" ], "variable": [ { "id": "5b07b641-8ac9-4a42-8435-8cad4b80f334", "key": "dashboardId", "value": "", "description": "(Required) A string value representing the dashboard id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "Get the information about the dashboard based on 'dashboardId' parameter. The Dashboard Info object contains lightweight information about the dashboard (e.g. title, image, assigned customers) but does not contain the heavyweight configuration JSON." }, "response": [ { "id": "a6db86f6-b794-45aa-a91b-5828585c991b", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/dashboard/info/:dashboardId", "host": [ "{{baseUrl}}" ], "path": [ "api", "dashboard", "info", ":dashboardId" ], "variable": [ { "key": "dashboardId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"title\": \"\",\n \"id\": {\n \"entityType\": \"DASHBOARD\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"image\": \"\",\n \"assignedCustomers\": [\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n },\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n }\n ],\n \"mobileHide\": \"\",\n \"mobileOrder\": \"\",\n \"version\": \"\",\n \"name\": \"\"\n}", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-a6db86f6-b794-45aa-a91b-5828585c991b" } ], "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-e8f7f85e-2433-4d49-a269-3a57ba115ea2" } ], "id": "444eda20-1772-4991-94af-ca8863e35c66", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-444eda20-1772-4991-94af-ca8863e35c66" } ], "id": "4faed6f1-9091-43a9-8343-fe8c05206939", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-4faed6f1-9091-43a9-8343-fe8c05206939" }, { "name": "home", "item": [ { "name": "info", "item": [ { "name": "Get Home Dashboard Info (getHomeDashboardInfo)", "id": "b1359325-6aec-40de-a976-2681ae996b06", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/dashboard/home/info", "host": [ "{{baseUrl}}" ], "path": [ "api", "dashboard", "home", "info" ] }, "description": "Returns the home dashboard info object that is configured as 'homeDashboardId' parameter in the 'additionalInfo' of the User. If 'homeDashboardId' parameter is not set on the User level and the User has authority 'CUSTOMER_USER', check the same parameter for the corresponding Customer. If 'homeDashboardId' parameter is not set on the User and Customer levels then checks the same parameter for the Tenant that owns the user. \n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "0ea0af8d-5cb8-4af8-a62f-c9a0eb825b05", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/dashboard/home/info", "host": [ "{{baseUrl}}" ], "path": [ "api", "dashboard", "home", "info" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"dashboardId\": {\n \"entityType\": \"DASHBOARD\",\n \"id\": \"\"\n },\n \"hideDashboardToolbar\": \"\"\n}", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-0ea0af8d-5cb8-4af8-a62f-c9a0eb825b05" } ], "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-b1359325-6aec-40de-a976-2681ae996b06" } ], "id": "d9ed6f52-481c-40c8-875e-72335317c5d9", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-d9ed6f52-481c-40c8-875e-72335317c5d9" }, { "name": "Get Home Dashboard (getHomeDashboard)", "id": "21787324-ae13-49d9-bc34-f3b2856ebfcd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept-Encoding", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/dashboard/home", "host": [ "{{baseUrl}}" ], "path": [ "api", "dashboard", "home" ] }, "description": "Returns the home dashboard object that is configured as 'homeDashboardId' parameter in the 'additionalInfo' of the User. If 'homeDashboardId' parameter is not set on the User level and the User has authority 'CUSTOMER_USER', check the same parameter for the corresponding Customer. If 'homeDashboardId' parameter is not set on the User and Customer levels then checks the same parameter for the Tenant that owns the user. 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).\n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "f0aa1a7a-14d6-4696-bd49-77fb0438b5b9", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept-Encoding", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/dashboard/home", "host": [ "{{baseUrl}}" ], "path": [ "api", "dashboard", "home" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-f0aa1a7a-14d6-4696-bd49-77fb0438b5b9" } ], "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-21787324-ae13-49d9-bc34-f3b2856ebfcd" } ], "id": "af105502-ea62-4bfa-9b16-3d75526c8a4b", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-af105502-ea62-4bfa-9b16-3d75526c8a4b" }, { "name": "Create or Update Dashboard (saveDashboard)", "id": "971f5776-fc1d-436e-b4f4-76790692edf2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept-Encoding", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"image\": \"\",\n \"mobileHide\": \"\",\n \"mobileOrder\": \"\",\n \"configuration\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"name\": \"\",\n \"resources\": [\n {\n \"link\": \"\",\n \"title\": \"\",\n \"type\": \"DASHBOARD\",\n \"subType\": \"SCADA_SYMBOL\",\n \"resourceKey\": \"\",\n \"fileName\": \"\",\n \"publicResourceKey\": \"\",\n \"isPublic\": \"\",\n \"mediaType\": \"\",\n \"data\": \"\",\n \"public\": \"\"\n },\n {\n \"link\": \"\",\n \"title\": \"\",\n \"type\": \"PKCS_12\",\n \"subType\": \"SCADA_SYMBOL\",\n \"resourceKey\": \"\",\n \"fileName\": \"\",\n \"publicResourceKey\": \"\",\n \"isPublic\": \"\",\n \"mediaType\": \"\",\n \"data\": \"\",\n \"public\": \"\"\n }\n ],\n \"id\": {\n \"entityType\": \"DASHBOARD\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"assignedCustomers\": [\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n },\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n }\n ],\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/dashboard", "host": [ "{{baseUrl}}" ], "path": [ "api", "dashboard" ] }, "description": "Create or update the Dashboard. When creating dashboard, platform generates Dashboard Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). The newly created Dashboard id will be present in the response. Specify existing Dashboard id to update the dashboard. Referencing non-existing dashboard Id will cause 'Not Found' error. Remove 'id', 'tenantId' and optionally 'customerId' from the request body example (below) to create new Dashboard entity. \n\nAvailable for users with 'TENANT_ADMIN' authority." }, "response": [ { "id": "f4aeb7cf-7cb6-4235-895b-6fba0205a939", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Accept-Encoding", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"image\": \"\",\n \"mobileHide\": \"\",\n \"mobileOrder\": \"\",\n \"configuration\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"name\": \"\",\n \"resources\": [\n {\n \"link\": \"\",\n \"title\": \"\",\n \"type\": \"DASHBOARD\",\n \"subType\": \"SCADA_SYMBOL\",\n \"resourceKey\": \"\",\n \"fileName\": \"\",\n \"publicResourceKey\": \"\",\n \"isPublic\": \"\",\n \"mediaType\": \"\",\n \"data\": \"\",\n \"public\": \"\"\n },\n {\n \"link\": \"\",\n \"title\": \"\",\n \"type\": \"PKCS_12\",\n \"subType\": \"SCADA_SYMBOL\",\n \"resourceKey\": \"\",\n \"fileName\": \"\",\n \"publicResourceKey\": \"\",\n \"isPublic\": \"\",\n \"mediaType\": \"\",\n \"data\": \"\",\n \"public\": \"\"\n }\n ],\n \"id\": {\n \"entityType\": \"DASHBOARD\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"assignedCustomers\": [\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n },\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n }\n ],\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/dashboard", "host": [ "{{baseUrl}}" ], "path": [ "api", "dashboard" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-f4aeb7cf-7cb6-4235-895b-6fba0205a939" } ], "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-971f5776-fc1d-436e-b4f4-76790692edf2" } ], "id": "5712a6c2-9830-4c6a-a1ab-a77b01b77038", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-5712a6c2-9830-4c6a-a1ab-a77b01b77038" }, { "name": "customer", "item": [ { "name": "{customerId}", "item": [ { "name": "dashboard", "item": [ { "name": "{dashboardId}", "item": [ { "name": "Assign the Dashboard (assignDashboardToCustomer)", "id": "7f4a6df0-56a6-4359-8378-2bbb0051f6b5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/customer/:customerId/dashboard/:dashboardId", "host": [ "{{baseUrl}}" ], "path": [ "api", "customer", ":customerId", "dashboard", ":dashboardId" ], "variable": [ { "id": "33045888-838f-4af6-815b-bf37f47efb47", "key": "customerId", "value": "", "description": "(Required) A string value representing the customer id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" }, { "id": "182ddfb3-2509-4cb8-8ebb-fa4af4de02c1", "key": "dashboardId", "value": "", "description": "(Required) A string value representing the dashboard id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "Assign the Dashboard to specified Customer or do nothing if the Dashboard is already assigned to that Customer. Returns the Dashboard object.\n\nAvailable for users with 'TENANT_ADMIN' authority." }, "response": [ { "id": "7abcb032-a259-4e00-992d-7ddabb2ceb7c", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/customer/:customerId/dashboard/:dashboardId", "host": [ "{{baseUrl}}" ], "path": [ "api", "customer", ":customerId", "dashboard", ":dashboardId" ], "variable": [ { "key": "customerId" }, { "key": "dashboardId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"title\": \"\",\n \"image\": \"\",\n \"mobileHide\": \"\",\n \"mobileOrder\": \"\",\n \"configuration\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"name\": \"\",\n \"resources\": [\n {\n \"link\": \"\",\n \"title\": \"\",\n \"type\": \"DASHBOARD\",\n \"subType\": \"SCADA_SYMBOL\",\n \"resourceKey\": \"\",\n \"fileName\": \"\",\n \"publicResourceKey\": \"\",\n \"isPublic\": \"\",\n \"mediaType\": \"\",\n \"data\": \"\",\n \"public\": \"\"\n },\n {\n \"link\": \"\",\n \"title\": \"\",\n \"type\": \"PKCS_12\",\n \"subType\": \"SCADA_SYMBOL\",\n \"resourceKey\": \"\",\n \"fileName\": \"\",\n \"publicResourceKey\": \"\",\n \"isPublic\": \"\",\n \"mediaType\": \"\",\n \"data\": \"\",\n \"public\": \"\"\n }\n ],\n \"id\": {\n \"entityType\": \"DASHBOARD\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"assignedCustomers\": [\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n },\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n }\n ],\n \"version\": \"\"\n}", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-7abcb032-a259-4e00-992d-7ddabb2ceb7c" } ], "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-7f4a6df0-56a6-4359-8378-2bbb0051f6b5" }, { "name": "Unassign the Dashboard (unassignDashboardFromCustomer)", "id": "3dc51a95-443d-4fb4-9f7f-5e3a2ec64852", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/customer/:customerId/dashboard/:dashboardId", "host": [ "{{baseUrl}}" ], "path": [ "api", "customer", ":customerId", "dashboard", ":dashboardId" ], "variable": [ { "id": "7204c2b0-8ff7-4bf9-901f-f8ccef39c839", "key": "customerId", "value": "", "description": "(Required) A string value representing the customer id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" }, { "id": "47c4cbb4-c8b8-46ec-b5e3-cf3d69c41624", "key": "dashboardId", "value": "", "description": "(Required) A string value representing the dashboard id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "Unassign the Dashboard from specified Customer or do nothing if the Dashboard is already assigned to that Customer. Returns the Dashboard object.\n\nAvailable for users with 'TENANT_ADMIN' authority." }, "response": [ { "id": "c3b2ff07-1d80-4258-bad7-5cf4a5535a62", "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/customer/:customerId/dashboard/:dashboardId", "host": [ "{{baseUrl}}" ], "path": [ "api", "customer", ":customerId", "dashboard", ":dashboardId" ], "variable": [ { "key": "customerId" }, { "key": "dashboardId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"title\": \"\",\n \"image\": \"\",\n \"mobileHide\": \"\",\n \"mobileOrder\": \"\",\n \"configuration\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"name\": \"\",\n \"resources\": [\n {\n \"link\": \"\",\n \"title\": \"\",\n \"type\": \"DASHBOARD\",\n \"subType\": \"SCADA_SYMBOL\",\n \"resourceKey\": \"\",\n \"fileName\": \"\",\n \"publicResourceKey\": \"\",\n \"isPublic\": \"\",\n \"mediaType\": \"\",\n \"data\": \"\",\n \"public\": \"\"\n },\n {\n \"link\": \"\",\n \"title\": \"\",\n \"type\": \"PKCS_12\",\n \"subType\": \"SCADA_SYMBOL\",\n \"resourceKey\": \"\",\n \"fileName\": \"\",\n \"publicResourceKey\": \"\",\n \"isPublic\": \"\",\n \"mediaType\": \"\",\n \"data\": \"\",\n \"public\": \"\"\n }\n ],\n \"id\": {\n \"entityType\": \"DASHBOARD\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"assignedCustomers\": [\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n },\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n }\n ],\n \"version\": \"\"\n}", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-c3b2ff07-1d80-4258-bad7-5cf4a5535a62" } ], "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-3dc51a95-443d-4fb4-9f7f-5e3a2ec64852" } ], "id": "68762dbf-dc5e-4f86-83a5-56c6e4f85595", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-68762dbf-dc5e-4f86-83a5-56c6e4f85595" } ], "id": "9b1e70a7-1b1f-4f9b-9048-225dc41652d8", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-9b1e70a7-1b1f-4f9b-9048-225dc41652d8" }, { "name": "dashboards", "item": [ { "name": "Get Customer Dashboards (getCustomerDashboards)", "id": "84a769c1-4999-4d4e-a87f-1918a9839b8c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/customer/:customerId/dashboards?pageSize=&page=&mobile=&textSearch=&sortProperty=title&sortOrder=ASC", "host": [ "{{baseUrl}}" ], "path": [ "api", "customer", ":customerId", "dashboards" ], "query": [ { "description": "(Required) Maximum amount of entities in a one page", "key": "pageSize", "value": "" }, { "description": "(Required) Sequence number of page starting from 0", "key": "page", "value": "" }, { "description": "Exclude dashboards that are hidden for mobile", "key": "mobile", "value": "" }, { "description": "The case insensitive 'substring' filter based on the dashboard title.", "key": "textSearch", "value": "" }, { "description": "Property of entity to sort by", "key": "sortProperty", "value": "title" }, { "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)", "key": "sortOrder", "value": "ASC" } ], "variable": [ { "id": "1e2c126c-202a-40d9-bf78-5cc276eedb26", "key": "customerId", "value": "", "description": "(Required) A string value representing the customer id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "Returns a page of dashboard info objects owned by the specified customer. 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. \n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "cee8b567-e752-4569-8376-fbc1c613a3e7", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/customer/:customerId/dashboards?pageSize=&page=&mobile=&textSearch=&sortProperty=title&sortOrder=ASC", "host": [ "{{baseUrl}}" ], "path": [ "api", "customer", ":customerId", "dashboards" ], "query": [ { "description": "(Required) Maximum amount of entities in a one page", "key": "pageSize", "value": "" }, { "description": "(Required) Sequence number of page starting from 0", "key": "page", "value": "" }, { "description": "Exclude dashboards that are hidden for mobile", "key": "mobile", "value": "" }, { "description": "The case insensitive 'substring' filter based on the dashboard title.", "key": "textSearch", "value": "" }, { "description": "Property of entity to sort by", "key": "sortProperty", "value": "title" }, { "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)", "key": "sortOrder", "value": "ASC" } ], "variable": [ { "key": "customerId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"title\": \"\",\n \"id\": {\n \"entityType\": \"DASHBOARD\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"image\": \"\",\n \"assignedCustomers\": [\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n },\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n }\n ],\n \"mobileHide\": \"\",\n \"mobileOrder\": \"\",\n \"version\": \"\",\n \"name\": \"\"\n },\n {\n \"title\": \"\",\n \"id\": {\n \"entityType\": \"DASHBOARD\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"image\": \"\",\n \"assignedCustomers\": [\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n },\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n }\n ],\n \"mobileHide\": \"\",\n \"mobileOrder\": \"\",\n \"version\": \"\",\n \"name\": \"\"\n }\n ],\n \"totalPages\": \"\",\n \"totalElements\": \"\",\n \"hasNext\": \"\"\n}", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-cee8b567-e752-4569-8376-fbc1c613a3e7" } ], "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-84a769c1-4999-4d4e-a87f-1918a9839b8c" } ], "id": "54e574ef-beb6-43e6-adde-0dfddd6bba99", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-54e574ef-beb6-43e6-adde-0dfddd6bba99" } ], "id": "d89edd75-800e-4f76-b0b7-bd6139c9cded", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-d89edd75-800e-4f76-b0b7-bd6139c9cded" }, { "name": "public", "item": [ { "name": "dashboard", "item": [ { "name": "{dashboardId}", "item": [ { "name": "Assign the Dashboard to Public Customer (assignDashboardToPublicCustomer)", "id": "93bd5460-f19a-4303-a820-77a6c6fe3432", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/customer/public/dashboard/:dashboardId", "host": [ "{{baseUrl}}" ], "path": [ "api", "customer", "public", "dashboard", ":dashboardId" ], "variable": [ { "id": "ec0abe89-5b08-467d-b05d-8cd3df41c3be", "key": "dashboardId", "value": "", "description": "(Required) A string value representing the dashboard id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "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](#!/asset-controller/assignAssetToPublicCustomerUsingPOST) and [assign Device to Public Customer](#!/device-controller/assignDeviceToPublicCustomerUsingPOST) for this purpose. Returns the Dashboard object.\n\nAvailable for users with 'TENANT_ADMIN' authority." }, "response": [ { "id": "2c7bb16e-8df8-4e7b-90e7-db8dd0b27f7f", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/customer/public/dashboard/:dashboardId", "host": [ "{{baseUrl}}" ], "path": [ "api", "customer", "public", "dashboard", ":dashboardId" ], "variable": [ { "key": "dashboardId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"title\": \"\",\n \"image\": \"\",\n \"mobileHide\": \"\",\n \"mobileOrder\": \"\",\n \"configuration\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"name\": \"\",\n \"resources\": [\n {\n \"link\": \"\",\n \"title\": \"\",\n \"type\": \"DASHBOARD\",\n \"subType\": \"SCADA_SYMBOL\",\n \"resourceKey\": \"\",\n \"fileName\": \"\",\n \"publicResourceKey\": \"\",\n \"isPublic\": \"\",\n \"mediaType\": \"\",\n \"data\": \"\",\n \"public\": \"\"\n },\n {\n \"link\": \"\",\n \"title\": \"\",\n \"type\": \"PKCS_12\",\n \"subType\": \"SCADA_SYMBOL\",\n \"resourceKey\": \"\",\n \"fileName\": \"\",\n \"publicResourceKey\": \"\",\n \"isPublic\": \"\",\n \"mediaType\": \"\",\n \"data\": \"\",\n \"public\": \"\"\n }\n ],\n \"id\": {\n \"entityType\": \"DASHBOARD\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"assignedCustomers\": [\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n },\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n }\n ],\n \"version\": \"\"\n}", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-2c7bb16e-8df8-4e7b-90e7-db8dd0b27f7f" } ], "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-93bd5460-f19a-4303-a820-77a6c6fe3432" }, { "name": "Unassign the Dashboard from Public Customer (unassignDashboardFromPublicCustomer)", "id": "192f5f2a-4a61-45e1-99cf-378f56342fd5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/customer/public/dashboard/:dashboardId", "host": [ "{{baseUrl}}" ], "path": [ "api", "customer", "public", "dashboard", ":dashboardId" ], "variable": [ { "id": "e4368b31-fd12-4882-8258-0551c6f2fd4e", "key": "dashboardId", "value": "", "description": "(Required) A string value representing the dashboard id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "Unassigns the dashboard from a special, auto-generated 'Public' Customer. Once unassigned, unauthenticated users may no longer browse the dashboard. Returns the Dashboard object.\n\nAvailable for users with 'TENANT_ADMIN' authority." }, "response": [ { "id": "f8f92a4d-2638-4025-bc64-6ae045146195", "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/customer/public/dashboard/:dashboardId", "host": [ "{{baseUrl}}" ], "path": [ "api", "customer", "public", "dashboard", ":dashboardId" ], "variable": [ { "key": "dashboardId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"title\": \"\",\n \"image\": \"\",\n \"mobileHide\": \"\",\n \"mobileOrder\": \"\",\n \"configuration\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"name\": \"\",\n \"resources\": [\n {\n \"link\": \"\",\n \"title\": \"\",\n \"type\": \"DASHBOARD\",\n \"subType\": \"SCADA_SYMBOL\",\n \"resourceKey\": \"\",\n \"fileName\": \"\",\n \"publicResourceKey\": \"\",\n \"isPublic\": \"\",\n \"mediaType\": \"\",\n \"data\": \"\",\n \"public\": \"\"\n },\n {\n \"link\": \"\",\n \"title\": \"\",\n \"type\": \"PKCS_12\",\n \"subType\": \"SCADA_SYMBOL\",\n \"resourceKey\": \"\",\n \"fileName\": \"\",\n \"publicResourceKey\": \"\",\n \"isPublic\": \"\",\n \"mediaType\": \"\",\n \"data\": \"\",\n \"public\": \"\"\n }\n ],\n \"id\": {\n \"entityType\": \"DASHBOARD\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"assignedCustomers\": [\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n },\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n }\n ],\n \"version\": \"\"\n}", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-f8f92a4d-2638-4025-bc64-6ae045146195" } ], "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-192f5f2a-4a61-45e1-99cf-378f56342fd5" } ], "id": "bb96c3e6-454e-4caf-ae94-c528683d7d5a", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-bb96c3e6-454e-4caf-ae94-c528683d7d5a" } ], "id": "08b9c44c-50ea-4b08-a372-83822f457a3b", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-08b9c44c-50ea-4b08-a372-83822f457a3b" } ], "id": "c5657cf3-c09e-46bd-940f-4fb00c80b7fa", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-c5657cf3-c09e-46bd-940f-4fb00c80b7fa" } ], "id": "61d5d6e3-7714-419f-ad8d-51cd529be9ad", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-61d5d6e3-7714-419f-ad8d-51cd529be9ad" }, { "name": "dashboards", "item": [ { "name": "Get Dashboards by Dashboard Ids (getDashboardsByIds)", "id": "3e66a485-6711-444d-83b8-280e28f64845", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/dashboards?dashboardIds=&dashboardIds=", "host": [ "{{baseUrl}}" ], "path": [ "api", "dashboards" ], "query": [ { "description": "(Required) A list of dashboard ids, separated by comma ','", "key": "dashboardIds", "value": "" }, { "description": "(Required) A list of dashboard ids, separated by comma ','", "key": "dashboardIds", "value": "" } ] }, "description": "Returns a list of DashboardInfo objects based on the provided ids. \n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "4c752e51-fc4d-438e-ae92-6dfb6779110e", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/dashboards?dashboardIds=", "host": [ "{{baseUrl}}" ], "path": [ "api", "dashboards" ], "query": [ { "description": "(Required) A list of dashboard ids, separated by comma ','", "key": "dashboardIds", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"title\": \"\",\n \"id\": {\n \"entityType\": \"DASHBOARD\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"image\": \"\",\n \"assignedCustomers\": [\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n },\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n }\n ],\n \"mobileHide\": \"\",\n \"mobileOrder\": \"\",\n \"version\": \"\",\n \"name\": \"\"\n },\n {\n \"title\": \"\",\n \"id\": {\n \"entityType\": \"DASHBOARD\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"image\": \"\",\n \"assignedCustomers\": [\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n },\n {\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"title\": \"\",\n \"isPublic\": \"\",\n \"public\": \"\"\n }\n ],\n \"mobileHide\": \"\",\n \"mobileOrder\": \"\",\n \"version\": \"\",\n \"name\": \"\"\n }\n]", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-4c752e51-fc4d-438e-ae92-6dfb6779110e" } ], "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-3e66a485-6711-444d-83b8-280e28f64845" } ], "id": "91e49c37-0910-4249-b3b7-4cd0cf5bd03f", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-91e49c37-0910-4249-b3b7-4cd0cf5bd03f" } ], "id": "669046e5-2213-4419-b9e9-46c410eda85f", "createdAt": "2026-07-28T03:12:10.000Z", "updatedAt": "2026-07-28T03:12:10.000Z", "uid": "35240-669046e5-2213-4419-b9e9-46c410eda85f" } ], "variable": [ { "key": "baseUrl", "value": "https://demo.thingsboard.io" } ] }