Skip to main content

Reports & exports

Generate documents and spreadsheet exports from objects. Each endpoint returns a URI to the generated file rather than the bytes directly.

Report document​

GET /data/{tenant}/{typeName}/{id}/reports/{reportName}?language={lang}

Generates the named report for a single object and returns its URI. The optional language parameter selects the report language.

TODO

Interview needed. Document how reportName maps to a report defined on the class, the language fallback behavior, and the lifecycle of the generated document (where it lives, expiry).

Excel export​

GET /data/{tenant}/excel/{typeName}
GET /data/{tenant}/excel/{relatedTypeName}/{relatedId}/{typeName}

Exports a filtered list (standalone or related) to an Excel file and returns its URI. Accepts the same filter parameters as the corresponding list endpoint.

TODO

Interview needed. Document which columns are exported (view definition? all fields?), how filters carry over, and the generated-file lifecycle.