Loading...
Overview

ReportInstance

ReportInstance is a resource representing the occurrence of a report within the digital customer platform. It is associated with a specific report template defined in the Report model and manages the lifecycle of report generation and storage. The resource includes details about the report's generation, visibility settings, and relations to uploaded files that represent the report output. It allows for retrieving specific instances of generated reports, including their metadata and file attachments.

Attributes

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

Name Description Permissions

Get ReportInstance by ID

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

Returns a specific ReportInstance by ID.


Relations

It is possible to get related objects from ReportInstances.

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

This table shows all available resources that can be queried

Relation Objecttype Relationtype
report Report 1:1 Show details

Update ReportInstance

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

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


Create ReportInstance

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

Create a new ReportInstance.


Delete ReportInstance

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

Delete the resource ReportInstance by ID.

Top Top