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.
Fields
Reference to a ReportTemplate to generate a report from.
Unique identifier of the report generated
Status of a generated report.
pending
, done
, error
Name given to the generated report.
Starting date of the generated report. Default dates of the report-template are applied if left null.
Ending date of the generated report. Default of the report-template are applied if left null.
Was this page helpful?