Loading...
Overview

Report

The Report resource represents a structured document associated with a specific Device on the digital customer platform. It typically includes data and analyses pertinent to the device's operational performance, maintenance, and other relevant metrics. Reports can contain multiple pages (ReportPage) and may be instantiated repeatedly (ReportInstances), each instance representing a distinct generation of the report's contents. Additionally, Reports can be configured to send to specific users (Recipients), enabling customized distribution of information within an organization.

Attributes

These are all attributes that can be read and updated through the API

Name Description Permissions

Get Report by ID

GEThttps://connect.autonoma.cloud/v1/resources/report/[ID]

Returns a specific Report by ID.


Relations

It is possible to get related objects from Reports.

GEThttps://connect.autonoma.cloud/v1/resources/report/[ID]/[RELATION]

This table shows all available resources that can be queried

Relation Objecttype Relationtype
device Asset 1:1 Show details
reportpages ReportPage 1:many Show details
reportinstances ReportInstance 1:many Show details

Update Report

POSThttps://connect.autonoma.cloud/v1/resources/report/[ID]

Update fields of Report by ID. The fields must be sent as x-www-form-urlencoded parameter.


Create Report

PUThttps://connect.autonoma.cloud/v1/resources/report

Create a new Report.


Delete Report

DELETEhttps://connect.autonoma.cloud/v1/resources/report/[ID]

Delete the resource Report by ID.

Top Top