Skip to content

reportDefinitions

Reports module · 5 operations

List report definition rows

GET/report-definitions

A report definition with NULL-aware aggregates. Reports respect RLS and masking. Returns a cursor page of report definition rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Create a report definition

POST/report-definitions

A report definition with NULL-aware aggregates. Reports respect RLS and masking. Creates a report definition. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Get a report definition

GET/report-definitions/{id}

A report definition with NULL-aware aggregates. Reports respect RLS and masking. Returns one report definition with its `ETag`. A report definition the caller may not see returns 404.

Update a report definition

PATCH/report-definitions/{id}

A report definition with NULL-aware aggregates. Reports respect RLS and masking. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

Delete a report definition

DELETE/report-definitions/{id}

A report definition with NULL-aware aggregates. Reports respect RLS and masking. Soft-deletes the report definition: it moves to Trash and can be restored for its table's retention period.