dRofus icon

dRofus

dRofus API: rooms, items, occurrences, room groups, room templates, systems, and RDL PDF reporting

Report → Start Report By Template

AI-generated

Summary

Start a dRofus report generation using a stored report template identified by its numeric Report ID, optionally overriding its filter, and choose whether to wait for the job to complete and retrieve the result or return immediately with the job ID.

Inputs

  • Report ID (required) — Numeric ID of the stored report template used to generate the report.
  • Filter Override — Optional JSON-quoted filter string to override the report template's built-in filter; leave empty to use the default filter.
  • Wait for Completion — Boolean to determine if the node should poll the job status until completion and download the report result (default true).
  • Wait Options — When waiting for completion, configure the polling interval (in milliseconds, 250-60000) and a timeout (in milliseconds) after which polling stops if the job is still running.

Output shape

A single JSON object with the report job outcome. If waiting for completion, includes the report result data; otherwise, contains just the jobId string.

If 'Wait for Completion' is true, the operation polls /jobs/{jobId}/status until completion or timeout, then downloads the result. If false, returns immediately with { jobId }. Polling parameters can be customized for interval and timeout.

Links

Discussion