...
...
As APIs publicas estão disponíveis em qualquer instalação do TReports e suas operações estão documentadas via Swagger.
Informações |
---|
Documentação no swagger: Api publica para integração |
...
Tendo um
...
...
...
...
...
...
...
...
...
...
Diferente da interface, na API não tem separação em contextos ('Meus Relatórios' e "Relatórios Compartilhados') então, o retorno é sempre todos os relatórios que contém no nome ou na descrição o filtro inserido.
GET: /api/reports/v1/resources
...
O filtro de Pastas é passado dessa forma ao final da URL:
?NavigationFolderId={ID-da-Pasta}
Informações |
---|
O filtro funciona assim como a própria busca via interface, ou seja, digitando no mínimo 3 caracteres já é possível buscar o nome de relatórios baseados naquilo que foi escrito. |
...
theme | RDark |
---|---|
title | Responde Body |
linenumbers | true |
...
...
...
...
...
...
...
...
...
Nessa requisição é possivel visualizar os parâmetros cadastrados no relatório pesquisado.
OPTIONS: /api/reports/v1/resources/{id-do-relatório}/generate
...
...
...
...
Geração do Relatório
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: /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"
} |
...
...
...
O download nada mais é do que uma forma de salvar o relatório gerado localmente em um formato especifico desejado, para fazer o download será preciso informar 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.
O Hyperlink permite que o produto integrador tenha acesso a um template de rota para acesso ao visualizador de um relatório sem utilizar o sistema como um todo.
GET: /api/reports/v1/hyperlinks
...
...
...
{
"viewer": "http://localhost:7017/reportsV2/myreports/document-view/{reportId}?access_token={accessToken}&refresh_token={refreshToken}&scope={scope}&token_type={tokenType}&expires_in={expiresIn}&hidemenus=true"
}
Os parâmetros do template podem ser inseridos de acordo com a necessidade do produto, sendo preenchido via QueryString, dessa forma, as URLs retornadas no hyperlink já virão com os parâmetros preenchidos de acordo com as informações colocadas.
Exemplo de URL enviando QueryString:
...
theme | Eclipse |
---|
...