Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

A "busca de relatório" é uma api que retorna os relatórios cadastrados no sistema, é possível buscar apenas os relatórios em que o usuário tem permissão de acesso, sejam eles de sua própria criação, compartilhados via pasta ou compartilhamento único. Assim como na interface do sistema, a busca possui a funcionalidade de filtro onde é necessário enviar no mínimo 3 caracteres para pesquisa, dessa forma, os relatórios que tiverem esses caracteres em comum em seu nome de exibição ou descrição serão retornados. 

Detalhes da implementação são encontrados no endpoint abaixo:

...

É importante destacar que alguns parâmetros podem ser do tipo MultivaloradoMultivalorados, ou seja, podem receber mais de um valor. Este tipo de parâmetro é reconhecido quando sua propriedade "multiValue" está definida como "true".

...

Cada solicitação é exclusiva de acordo com os parâmetros necessários, neste caso serão enviados no corpo da requisição "body" os parâmetros e seus respectivos valores conforme exemplo abaixo:

Bloco de código
themeRDark
titleBody
{
  "pCodEscr": ["SP001", "SP001"],
  "pCodFatura": "000000180",
  "pNomeSocio": "Isabelle Silva"
}

...

Este endpoint define o formato em que o arquivo será retornado. Os formatos disponíveis para download são:

FormatoDescrição
PDFpdfPortable Document Format
XLSxlsExcel até 2012
XLSXxlsx

Excel a partir de 2010

RFTrftRich Text Format
DOCXdocxDocumento de processamento de texto
MHTmhtArmazenamento de um arquivo de página da web

HTMLhtml

Linguagem de Marcação de Hipertexto
TXTtxtArquivo de Texto
CSVcsvComma-Separated-Values
JPEGjpegArquivo de imagem comprimido
PNGpngPortable Network Graphics

...

Para utilizar essa requisição vamos precisar de um ID de um relatório existente: e6d724bd-8505-4702-9fa8-a2672c3b9c94

Os demais parâmetros podem ser informados por meio de QueryString ou diretamente na URL retornada.
Exemplo de URL pronta:

...

Esses parametros são as informações de token de usuário que irá abrir a interface da integração e são utilizadas para realizar contextualização e verificação de permissões.

Com a URL configurada vamos acessar um browser para visualização da mesma, é apresentado o relatório informado e após a conclusão da geração podem ser utilizados os recursos da inteface para fazer, por exemplo, o download do relatório.

...

Para realizar testes é necessário o uso de alguma aplicação que simule requisições HTTP.
Informações
titleInformações


As APIs publicas estão disponíveis em qualquer instalação do TReports apartir da versão 1.4 e suas operações estão documentadas via Swagger.

Nota