Pular para o conteúdo principal
PATCH
/
v1
/
templates
/
{id}
Atualizar um Template
curl --request PATCH \
  --url https://reporter.sandbox.lerian.net/v1/templates/{id} \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-Organization-id: <x-organization-id>' \
  --form template='@example-file' \
  --form outputFormat=HTML \
  --form 'description=Financial Report'
{
  "id": "0196b1d2-399c-7aff-8941-3ea99d1525d4",
  "outputFormat": "HTML",
  "description": "Financial Report",
  "fileName": "0196b1d2-399c-7aff-8941-3ea99d1525d4.tpl",
  "createdAt": "2025-05-08T21:34:26.716Z",
  "updatedAt": "2025-05-08T21:50:24.844Z",
  "deletedAt": null
}

Cabeçalhos

​
Authorization
string

O token de autorização no formato 'Bearer '.
Importante: Este header é obrigatório se o seu ambiente tiver o Access Manager habilitado. Para mais informações, consulte a documentação do Access Manager.

​
Content-Type
string
obrigatório

O tipo de conteúdo da requisição. Importante: Para este endpoint, deve ser multipart/form-data.

​
X-Organization-id
string
obrigatório

O identificador único da Organização associada à requisição.

Parâmetros de caminho

​
id
string
obrigatório

Identificador único do template que você deseja recuperar (UUID).

Corpo

multipart/form-data
​
template
file
obrigatório

O novo arquivo de template.

​
outputFormat
enum<string>
obrigatório

O formato de saída que será gerado pelo novo template.

Opções disponíveis:
HTML,
CSV,
XML,
PDF,
TXT
​
description
string

Uma breve descrição sobre o novo template.

Resposta

Indica que o recurso foi atualizado com sucesso e a operação foi concluída conforme esperado.

​
id
string

ID único que identifica o template. Segue o formato UUID.

​
outputFormat
string

O formato da saída gerada (ex., HTML, CSV, PDF, TXT, XML).

​
description
string

Descreve brevemente para que serve o template ou o que ele contém.

​
fileName
string

O nome do arquivo de template conforme armazenado no sistema. Segue o formato <template_id>.tpl.

​
createdAt
string

Data e hora em que o template foi criado.

​
updatedAt
string

Timestamp indicando a última vez que o template foi atualizado.

​
deletedAt
string

Timestamp indicando quando o template foi excluído logicamente.