Pular para o conteúdo principal
POST
/
v1
/
templates
Fazer Upload de um Template
curl --request POST \
  --url https://reporter.sandbox.lerian.net/v1/templates \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-Organization-id: <x-organization-id>' \
  --form template='@example-file' \
  --form outputFormat=TXT \
  --form 'description=List of holders'
{
  "id": "0196b270-a315-7137-9408-3f16af2685e1",
  "outputFormat": "TXT",
  "description": "List of holders",
  "fileName": "0196b270-a315-7137-9408-3f16af2685e1.tpl",
  "createdAt": "2025-05-09T00:27:28.405080783Z",
  "updatedAt": "2025-05-09T00:27:28.405080783Z"
}
Need a sample to test this endpoint? Click here to download a sample .tpl file.

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.

​
X-Idempotency
string

Chave de idempotência opcional para retentativas seguras. Se omitida, o servidor pode gerar uma automaticamente.

Consulte Retentativas e idempotência para mais detalhes.

Corpo

multipart/form-data
​
template
file
obrigatório

O arquivo .tpl que você criou para servir como definição do template.

​
outputFormat
enum<string>
obrigatório

O formato do relatório que o template irá gerar.

Opções disponíveis:
HTML,
CSV,
XML,
PDF,
TXT
Exemplo:

"TXT"

​
description
string
obrigatório

Uma breve descrição sobre o template.

Exemplo:

"List of holders"

Resposta

Indica que o template foi criado com sucesso.

A resposta inclui o header X-Idempotency-Replayed.

Se o valor for false, a requisição foi recém-processada. Se o valor for true, a resposta é uma repetição de uma requisição processada anteriormente.

A resposta também pode incluir warnings quando a validação de schema não conseguiu validar completamente uma ou mais fontes de dados referenciadas pelo template. O template é criado mesmo assim.

Consulte Retentativas e idempotência para mais detalhes.

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.