Actions69
- Item Actions
- Occurrence Actions
- Other Resource Actions
- Report Actions
- Room Actions
- Room Group Actions
- Room Template Actions
Report → Start Batch
AI-generatedSummary
Start a batch report job by submitting a JSON report body including file naming and report details, optionally waiting for job completion to retrieve results.
Inputs
- Report Body (JSON) (required) — Provide a free-form RDL JSON document specifying the batch report, formatted as { "fileNamePropertyId": ..., "report":
}. - Wait for Completion — Choose whether to poll the job status until completion and download the result; when false, returns job ID immediately.
- Wait Options — Configure polling interval (milliseconds) and timeout duration (milliseconds) used when waiting for job completion.
Output shape
The operation returns either an object containing the completed report data (if waiting is enabled) or an object containing just the { jobId } of the started batch job (if not waiting).
If wait for completion is enabled, the node polls the job status endpoint until the job finishes or the timeout elapses, then downloads and returns the report results. If waiting is disabled, it returns immediately with the job ID only, allowing asynchronous workflow handling.
Examples
Example 1: Start a batch report and wait for it to finish
Set 'Report Body (JSON)' with the batch report definition, enable 'Wait for Completion', and configure polling options as needed to retrieve the full report output.
Example 2: Start a batch report without waiting
Provide the batch report JSON, disable 'Wait for Completion' to immediately proceed with the job ID for external monitoring or parallel processing.