Skip to main content
PATCH
Update a template

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

id
string
required

Template ID

Body

multipart/form-data

Template multipart form

category
string

Report family this template belongs to — what a consumer routes by. Held to the grammar ^[a-z0-9_-]{1,100}$ AFTER normalisation: lower-case letters, digits, underscores and hyphens, at most 100 characters. Case and surrounding spaces are corrected, so 'CADOC' and ' cadoc ' are both stored as 'cadoc'; a space inside the value, a dot, a slash or an accent is refused rather than rewritten. Required on create. On update it is required only when the template does not already have a category — one that already carries a category keeps it and need not repeat it, which is why the update operation does not list this field as required.

Pattern: ^[a-z0-9_-]{1,100}$
Example:

"cadoc"

description
string

Human-readable template description

Example:

"Monthly financial report"

outputFormat
string

Generated report output format

Example:

"html"

template
file

Pongo2 template file

Response

OK

category
string

Report family this template belongs to, lower-case; empty on a template stored before categories existed

Example:

"cadoc"

createdAt
string<date-time>

Template creation timestamp in UTC

Example:

"2021-01-01T00:00:00Z"

description
string

Human-readable template description

Example:

"Monthly financial report"

fileName
string

Stored template filename

Example:

"0196159b-4f26-7300-b3d9-f4f68a7c85f3_1744119295.tpl"

id
string

Unique template identifier

Example:

"00000000-0000-0000-0000-000000000000"

outputFormat
string

Format generated from this template

Example:

"HTML"

parameters
object[] | null

Generation parameters this template declares; a report request must answer each required one. Empty when the template declares none

updatedAt
string<date-time>

Most recent template update timestamp in UTC

Example:

"2021-01-01T00:00:00Z"

warnings
object[] | null

Non-fatal mapped-field validation warnings returned when a data source is unavailable

Example: