...
Índice | ||||
---|---|---|---|---|
|
...
O objetivo deste documento é esclarecer o funcionamento das APIs para busca, geração e download de um Relatório e também para utilizar sobre o funcionamento do TReports via QueryString e Hyperlink.
...
Aqui é É possível buscar todos os relatórios que o usuário tem permissão, seja eles compartilhados via pasta ou compartilhamento único.
GET: {{dominio}}/api/reports/v1/resources
...
Para fazer a geração é necessário informar o ID do Relatório, o tempo que a geração ficara disponível para consultas e seu parâmetro, caso já tenha sido previamente cadastrado.
POST: {{dominio}}/api/reports/v1/resources/{id-do-relatório}/generate?ttl=1440
Caso o relatório possua parâmetros cadastrados é necessário informar no body da requisição.:
Bloco de código |
---|
{ "nome-do-parâmetro": "valor-desejado-do-parâmetro" } |
...
Para fazer o download será utilizado o ID da geração do relatório e o formato para download desejado.
GET: /api/reports/v1/generated/{id-da-geração}/{formato}
Formatos disponíveis: PDF, XLS, XLSX, RTF, DOCX, MHT, HTML, TXT, CSV, JPEG e PNG
Ao fim da requisição será possível visualizar o relatório no formato escolhido e fazer o seu download.
...
Hyperlink é utilizado para fazer a visualização de um relatório sem utilizar o sistema como um todo.
GET: /api/reports/v1/hyperlinks
...
A querystring no TReports é utilizada para visualizar o sistema sem que mostre seus menus.