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

Documentation Index

Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt

Use this file to discover all available pages before exploring further.

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

Novo arquivo .tpl. Opcional. Quando enviado sem outputFormat, o arquivo é validado contra o outputFormat existente do template.

​
outputFormat
enum<string>

Formato de saída gerado pelo novo template. Opcional. Aceito apenas em conjunto com um novo arquivo template. Enviar outputFormat sem template retorna erro 400.

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

Uma breve descrição do template. Opcional.

Resposta

Indica que o template foi atualizado com sucesso.

Detalhes sobre o template que foi criado ou atualizado.

​
id
string

ID único que identifica o template (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

Timestamp indicando quando o template foi criado.

​
updatedAt
string

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

​
warnings
object[]

Retornado quando a validação de schema não conseguiu validar completamente uma ou mais fontes de dados referenciadas pelo template. A operação de criação ou atualização é concluída mesmo assim. Ausente quando nenhum aviso foi produzido.