Resource
report
A reusable report with an editable draft and immutable published versions.
Configuration
publishedSourcereport_documentOptionalReport document, including its sources and outputs.
report_document fields
The root element: a report's parameters, data sources, preparation and output files. Save and publish a version before running or scheduling it.
definitionOptionaloutputsOptionalparametersOptionalpreparationScriptOptionalschemaVersionOptionalVersion of the report format. Only 1 is supported.
snapshotRetentionDaysOptionalDays to keep the data captured for each run, so a failed run can be retried or rendered again; 1 to 3650.
sourcesOptionaltablePlanOptionaltransformsOptionalAll of these apply
Choose exactly one shape
outputsRequireddefinitionRequiredOnly the fields listed here are accepted.
written by `publishReportSource`, not by this resource's update
sourcereport_documentRequiredReport document, including its sources and outputs.
report_document fields
The root element: a report's parameters, data sources, preparation and output files. Save and publish a version before running or scheduling it.
definitionOptionaloutputsOptionalparametersOptionalpreparationScriptOptionalschemaVersionOptionalVersion of the report format. Only 1 is supported.
snapshotRetentionDaysOptionalDays to keep the data captured for each run, so a failed run can be retried or rendered again; 1 to 3650.
sourcesOptionaltablePlanOptionaltransformsOptionalAll of these apply
Choose exactly one shape
outputsRequireddefinitionRequiredOnly the fields listed here are accepted.
nameString!RequiredHuman-readable report name.
Read-only values
Show values
revisionInt!Read onlyMonotonic authoring revision; changes on draft saves and publication.
computed by the platform
idReportID!Read onlyOpaque identifier of this resource.
computed by the platform
currentVersionIdReportVersionIDRead onlyPublished version currently selected for this report; null before first publication.
computed by the platform
hasDraftBoolean!Read onlyWhether an editable definition exists independently of the published version.
computed by the platform
sourceXMLStringRead onlyExact authored draft XML, if present.
computed by the platform
draftDefinitionStringRead onlyEditable definition JSON; null after publication.
computed by the platform
archivedBoolean!Read onlyWhether the report has been archived from active authoring.
computed by the platform
createdAtString!Read onlyCreation timestamp in ISO 8601 format.
computed by the platform
updatedAtString!Read onlyLast modification timestamp in ISO 8601 format.
computed by the platform
Lifecycle
The CLI can create this resource. The platform assigns its id.
When replacement is needed, the existing resource is removed before its replacement is created.