Update a template

Updates a template’s file, output format, or description.

PATCH /v1/templates/{templateId}

Update a template

cURL

curl --request PATCH \
  --url https://reporter.sandbox.lerian.net/v1/templates/{templateId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form category=cadoc \
  --form 'description=Monthly financial report' \
  --form outputFormat=html \
  --form template=@example-file

200

{
  "category": "cadoc",
  "createdAt": "2021-01-01T00:00:00Z",
  "description": "Monthly financial report",
  "fileName": "0196159b-4f26-7300-b3d9-f4f68a7c85f3_1744119295.tpl",
  "id": "00000000-0000-0000-0000-000000000000",
  "outputFormat": "HTML",
  "parameters": [
    {
      "name": "dataBase",
      "required": true,
      "type": "month",
      "allowedValues": [
        "I",
        "S"
      ],
      "appliesTo": "midaz_transaction.operation.created_at",
      "default": "I",
      "description": "<string>"
    }
  ],
  "updatedAt": "2021-01-01T00:00:00Z",
  "warnings": [
    {
      "code": "DATA_SOURCE_UNAVAILABLE",
      "field": "account.balance",
      "message": "data source is temporarily unavailable"
    }
  ]
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

templateId · string · requerido

Template ID

Cuerpo

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}$

Ejemplo:

"cadoc"

description · string

Human-readable template description

Ejemplo:

"Monthly financial report"

outputFormat · string

Generated report output format

Ejemplo:

"html"

template · file

Pongo2 template file

Respuesta

200

application/json

OK

category · string

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

Ejemplo:

"cadoc"

createdAt · string<date-time>

Template creation timestamp in UTC

Ejemplo:

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

description · string

Human-readable template description

Ejemplo:

"Monthly financial report"

fileName · string

Stored template filename

Ejemplo:

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

id · string

Unique template identifier

Ejemplo:

"00000000-0000-0000-0000-000000000000"

outputFormat · string

Format generated from this template

Ejemplo:

"HTML"

parameters · object[] | null

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

Show child attributes

updatedAt · string<date-time>

Most recent template update timestamp in UTC

Ejemplo:

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

warnings · object[] | null

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

Show child attributes

Ejemplo:

[
  {
    "code": "DATA_SOURCE_UNAVAILABLE",
    "field": "account.balance",
    "message": "data source is temporarily unavailable"
  }
]