Embarcador - [POST] Consultar dados de relatório | Help Center

Consultar dados de relatório

Método: POST
Endpoint: {{API_URL}}/api/Report/Download

Cabeçalhos

Cabeçalho	Valor	Obrigatório
`Authorization`	`Bearer {token}`	Sim
`Content-Type`	`application/json`	Sim

O que esse endpoint faz

Gera e retorna o relatório no formato solicitado.

Formatos suportados

CSV
PDF
EXCELOPENXML

Regras de uso dos parâmetros

Datas devem ser informadas no formato AAAA-MM-DD.
Parâmetros com MultiValue podem ser repetidos múltiplas vezes na requisição, cada um com um valor diferente.
Parâmetros com DefaultValue = '%' usam o operador LIKE do SQL; nesse caso, % significa que não há filtro para aquele parâmetro.
Todos os parâmetros obrigatórios devem ser enviados com valores válidos, de acordo com o tipo esperado.

Corpo da requisição

Campo	Tipo	Descrição
`reportId`	UUID	Identificador do relatório que será gerado
`format`	String	Formato de saída solicitado
`parameters`	Lista	Parâmetros que serão usados no relatório

Estrutura dos parâmetros da requisição

Campo	Tipo	Descrição
`parameterName`	String	Nome técnico do parâmetro
`parameterValue`	String	Valor informado para o parâmetro

Exemplo de requisição

JSON

{
  "reportId": "00000000-0000-0000-0000-000000000000",
  "format": "CSV",
  "parameters": [
    {
      "parameterName": "StartDate",
      "parameterValue": "2026-07-01"
    },
    {
      "parameterName": "EndDate",
      "parameterValue": "2026-07-27"
    }
  ]
}

Resposta de sucesso

JSON

{
  "fileName": "relatorio.csv",
  "contentType": "text/csv",
  "base64": "UEsDBBQAAAAI..."
}

Campos da resposta

Campo	Tipo	Descrição
`fileName`	String	Nome do arquivo gerado
`contentType`	String	Tipo MIME do conteúdo retornado
`base64`	String	Conteúdo do relatório em Base64

Respostas possíveis

Código HTTP	Descrição
`200 OK`	Relatório gerado com sucesso
`400 Bad Request`	Formato inválido, parâmetros faltando ou valores fora do esperado
`404 Not Found`	Relatório inexistente ou não encontrado
`500 Internal Server Error`	Falha interna ao gerar o relatório

Observações

Todos os parâmetros obrigatórios devem ser preenchidos.
O resultado é retornado em Base64, não como arquivo binário direto.