Reports
The report resource
A report is generated from an existing report-template, referenced by its unique identifier templateId
.
Status
The generation of a report content is a background process. As long as this process is not complete, the report status stays pending
. Once the report is complete, its status is set to done
. May an error be encountered while generating its content, then its status is set to error
.
The report content can only be viewed and downloaded once it is done
.
Start & end dates
Start startsOn
and end endsOn
dates can be left null
. In this case, default dates from the report-template are applied.
Filters
Filters are usually set in the report-template. But these can be overriden for a given report.