dRofus icon

dRofus

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

Report → Start Report

AI-generated

Summary

Start a dRofus report job by submitting a full RDL JSON report body, optionally waiting for job completion and fetching the report output.

Inputs

  • Report Body (JSON) (required) — The complete RDL JSON document representing the report contract root to start the report job.
  • Wait for Completion — Flag to determine whether to poll the job status until completion and download the report output or return immediately with only the job ID.
  • Wait Options — Configuration for polling intervals and timeout duration when waiting for job completion.

Output shape

a JSON object containing the jobId if waiting is disabled; otherwise the downloaded report data (binary or structured as per the report output).

If 'Wait for Completion' is true, the node polls the job status endpoint periodically based on 'Wait Options' until it completes or times out, then downloads the report result. If false, it returns immediately with only the job identifier.

Links

Discussion