Actions69
- Item Actions
- Occurrence Actions
- Other Resource Actions
- Report Actions
- Room Actions
- Room Group Actions
- Room Template Actions
Report → Start Batch By Template
AI-generatedSummary
Start a batch report generation based on a stored report template in dRofus, optionally waiting for the job to complete and fetching the result.
Inputs
- Report ID (required) — The numeric ID of the stored report template to base the batch report on.
- Report Body (JSON) (required) — A JSON object specifying batch report parameters, including 'fileNamePropertyId' and optionally an 'additionalReportFilter' to customize the report.
- Wait for Completion — Boolean flag to indicate whether to poll the job status until completion and retrieve the report result, or to return immediately with the job ID.
- Wait Options — Configuration options for polling when waiting for completion, including poll interval (milliseconds) and timeout (milliseconds).
Output shape
An object containing at least the jobId of the started batch report job. If waiting for completion, includes the final report result as binary or JSON data.
When 'Wait for Completion' is true, the node polls the job status until finished or times out, then downloads and outputs the report result. When false, it returns immediately with only the jobId, without waiting or fetching the output.
Examples
Example 1: Start a batch report from a template with specific filters, wait for completion, and retrieve the report data in the workflow.
Set 'Report ID' to the template's ID, provide 'Report Body' JSON with 'fileNamePropertyId' and any filters, enable 'Wait for Completion' (true), and configure poll interval and timeout as needed.