Embarcador - [GET] Relatórios Disponíveis | Help Center

Consultar relatórios disponíveis

Método: GET
Endpoint: {{API_URL}}/api/Report

Cabeçalho

Cabeçalho	Valor	Obrigatório
`Authorization`	`Bearer {token}`	Sim

O que esse endpoint faz

Retorna todos os relatórios disponíveis no diretório configurado.

Cada relatório retorna:

id
name
description
parameters

Estrutura do retorno

Campo	Tipo	Descrição
`id`	UUID	Identificador único do relatório, que será utilizado na consulta dos dados do relatório
`name`	String	Nome do relatório
`description`	String	Descrição do relatório
`parameters`	Lista	Parâmetros disponíveis para filtrar as informações

Estrutura dos parâmetros (filtros) do retorno

Campo	Tipo	Descrição
`parameterName`	String	Nome técnico do campo do filtro
`description`	String	Descrição funcional do parâmetro
`parameterType`	String	Tipo esperado do parâmetro
`nullable`	Boolean	Indica se o parâmetro aceita valor nulo
`allowBlank`	Boolean	Indica se o campo pode vir em branco
`multiValue`	Boolean	Indica se o parâmetro aceita múltiplos valores
`defaultValues`	Lista de strings	Valores padrão do parâmetro
`validValues`	Lista	Valores válidos permitidos

Estrutura dos valores válidos

Campo	Tipo	Descrição
`label`	String	Rótulo exibido para o valor
`value`	String	Valor técnico enviado na requisição

Exemplo de resposta

JSON

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "Relatório X",
    "description": "Relatório para análise de pendências",
    "parameters": [
      {
        "parameterName": "StartDate",
        "description": "Data inicial",
        "parameterType": "DateTime",
        "nullable": false,
        "allowBlank": false,
        "multiValue": false,
        "defaultValues": [],
        "validValues": []
      }
    ]
  }
]

Respostas possíveis

Código HTTP	Descrição
`200 OK`	Lista retornada com sucesso
`400 Bad Request`	Requisição inválida
`404 Not Found`	Nenhum relatório encontrado
`500 Internal Server Error`	Falha interna ao consultar a lista