Skip to main content
GET

Quando usar

Use esta rota quando você quer o link do arquivo na própria resposta. A chamada só volta depois que o arquivo está pronto, então use um timeout generoso no seu cliente HTTP. Para não segurar a conexão, ou para gerar PDF e Excel juntos, use Exportar Relatório (Assíncrono).

Autenticação

Bearer JWT no header Authorization.

Parâmetros

Sem sectionOrder, valem as seções e a ordem do modelo (o escolhido, senão o padrão da organização, senão o do sistema).

Resposta

A resposta é o registro da exportação. O link está em url. O link também fica gravado no relatório, em exportUrl (PDF) ou exportExcelUrl (Excel). O link do Excel expira em 7 dias.
A rota responde 202 mesmo no sucesso, com o arquivo já pronto. Trate 202 com url preenchida como sucesso. Um relatório inexistente ou de outra organização não gera arquivo e responde erro.

Authorizations

Authorization
string
header
required

Enter JWT token

Path Parameters

id
string
required

ID do relatorio a exportar.

Query Parameters

type
enum<string>
required

Obrigatorio. Use REPORT. Sem ele, a resposta e 400.

Available options:
REPORT,
REPORT_MINIFIED
exportFormat
enum<string>

pdf (padrao) ou excel. both nao e suportado nesta rota: use a exportacao assincrona.

Available options:
pdf,
excel,
both
sectionOrder
string[]

Secoes do arquivo, na ordem desejada. Repita o parametro para cada secao. Sem ele, valem as secoes e a ordem do modelo.

templateId
string

ID de um modelo de exportacao da organizacao.

systemTemplate
enum<string>

Modelo nativo de exportacao.

Available options:
COMPLETE,
COMPACT

Response

Registro da exportacao, com o arquivo ja pronto. O link esta em url.

id
string
url
string

Link do arquivo gerado.

payload
object
userId
string
organizationId
string
typeId
string
createdAt
string<date-time>
updatedAt
string<date-time>