Sidebar
Overview
Resources
Dashboard
The Dashboard resource in the digital customer platform serves as a customizable display area for users to monitor and interact with their digitalized industrial assets. Each dashboard is associated with an account and can contain multiple widgets, which are modular units that provide specific functionality, such as displaying data from devices or controlling device settings. The 'dashboards' table stores each dashboard's unique identifier, name, and associated widgets. Dashboard configuration includes the widgets' settings and allows users to personalize their visualization and management of devices linked to the platform.Attributes
These are all attributes that can be read and updated through the API
Name | Description | Permissions |
---|---|---|
id | A unique identifier for the Dashboard model. It is typically an integer or a UUID that is automatically generated when a new Dashboard is created and used to uniquely identify the Dashboard within the system. | READ ONLY |
name | The name attribute represents the title or label of the Dashboard. It is a string that provides an easy-to-understand reference to the content and purpose of the Dashboard for users. | READ AND UPDATE |
Get Dashboard by ID
GEThttps://connect.autonoma.cloud/v1/resources/dashboard/[ID]Returns a specific Dashboard by ID.
Relations
It is possible to get related objects from Dashboards.
GEThttps://connect.autonoma.cloud/v1/resources/dashboard/[ID]/[RELATION]This table shows all available resources that can be queried
Relation | Objecttype | Relationtype | |
---|---|---|---|
account | Account | 1:1 | Show details |
devices | Asset | many:1 | Show details |
Update Dashboard
POSThttps://connect.autonoma.cloud/v1/resources/dashboard/[ID]Update fields of Dashboard by ID. The fields must be sent as x-www-form-urlencoded parameter.
Create Dashboard
PUThttps://connect.autonoma.cloud/v1/resources/dashboardCreate a new Dashboard.
Delete Dashboard
DELETEhttps://connect.autonoma.cloud/v1/resources/dashboard/[ID]Delete the resource Dashboard by ID.
This action can not be reverted!