Widget
The Widget resource represents a customizable UI component on the digital customer platform, allowing users to visualize and interact with data from associated industrial assets. Widgets can be linked to dashboards, device inputs, and report pages, and are customizable through a configuration that specifies properties such as data sources, layout, and types. Common widget types include charts, tables, and status indicators for real-time or historical data analysis.Attributes
These are all attributes that can be read and updated through the API
| Name | Description | Permissions |
|---|---|---|
| name | The unique identifier or title for the widget, often used for display purposes. | READ AND UPDATE |
| description | A detailed explanation of the widget's purpose and functionality. | READ AND UPDATE |
| config | A JSON object containing configuration settings and properties for the widget's operation and appearance. | READ AND UPDATE |
| type | The category or classification of the widget, indicating its functionality or intended use. | READ AND UPDATE |
| widget_template_id | A reference ID to the template from which this widget is derived or instantiated. | READ AND UPDATE |
Get Widget by ID
GEThttps://app.autonoma.cloud/connect/v1/resources/widget/[ID]Returns a specific Widget by ID.
Relations
It is possible to get related objects from Widgets.
GEThttps://app.autonoma.cloud/connect/v1/resources/widget/[ID]/[RELATION]This table shows all available resources that can be queried
| Relation | Objecttype | Relationtype | |
|---|---|---|---|
| dashboards | Dashboard | many:many | Show details |
| datastream | Datastream | many:many | Show details |
| reportpages | ReportPage | many:many | Show details |
Update Widget
POSThttps://app.autonoma.cloud/connect/v1/resources/widget/[ID]Update fields of Widget by ID. The fields must be sent as x-www-form-urlencoded parameter.
Create Widget
PUThttps://app.autonoma.cloud/connect/v1/resources/widgetCreate a new Widget.
Delete Widget
DELETEhttps://app.autonoma.cloud/connect/v1/resources/widget/[ID]Delete the resource Widget by ID.
This action can not be reverted!