Última modificação em: 10/10/2022
POST - /TnWebDMRelatorio/Executar
Permite executar um relatório do sistema, retornando o conteúdo no formato desejado.
Parâmetros
Parâmetro |
Obrigatório |
Tipo do Parâmetro |
Descrição |
Valores Válidos |
tokenapi |
Não |
Texto |
Token de validação do acesso. Se a base de dados possuir um token cadastrado passa a ser obrigatório informar o mesmo |
|
_AActionName |
Sim |
Texto |
Nome interno do relatório a ser acessado |
|
_ABase64 |
Sim |
Texto |
Indica se o retorno deve ser convertido para base 64 ou não |
True False |
_ATipoRetorno |
Sim |
Texto |
Formato de exportação do relatório que será utilizado no retorno |
nrwexRtf nrwexHtml nrwexTxt nrwexCSV nrwexJpeg nrwexPDF nrwexNHZ |
Body
Informar no body um JSON contendo os valores dos parâmetros que devem ser utilizados no relatório. O JSON deve conter um objeto "reportParameters" e cada propriedade do objeto deve corresponder a um parâmetro do relatório.
Ex:
{"reportParameters":{"pCompleto":2, "pFiltrarBaixados":1}}
Para obter uma lista com os parâmetros e os valores válidos para os mesmos, utilize a requisição /TnWebDMDadosObjetos/Pegar repassando o nome interno do relatório.
Respostas
Resposta | Conteúdo |
200 |
Retorna um JSON com algumas informações e o conteúdo do relatório impresso no formato do parâmetro "_ATipoRetorno". Ex: { |
200 |
Pode retornar um JSON com algum erro nos parâmetros informados. Ex: { |
401 |
Acontece quando a base possui um token de validação que não foi repassado através do parâmetro "tokenapi" ou está incorreto. Ex: { |