Skip to main content
POST
Creates a ReportDefinition resource.

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Body

application/json

The new ReportDefinition resource

A saved, editable custom report: a root entity plus the query DSL (selected fields + filter conditions + ordering) that {@see App\Service\NaturalQuery\QueryCompiler} consumes to produce rows. Tenant-isolated; created/updated/downloaded actions are audit-logged via {@see App\Entity\Log}.

name
string
rootEntity
string
definition
(string | null)[]

Response

ReportDefinition resource created

A saved, editable custom report: a root entity plus the query DSL (selected fields + filter conditions + ordering) that {@see App\Service\NaturalQuery\QueryCompiler} consumes to produce rows. Tenant-isolated; created/updated/downloaded actions are audit-logged via {@see App\Entity\Log}.

uuid
string
name
string
rootEntity
string
definition
(string | null)[]
owner
string<iri-reference> | null
Example:

"/api/v1/users/1"

dateCreated
string<date-time>
read-only
dateUpdated
string<date-time> | null
read-only