Árvore de páginas

Versões comparadas

Chave

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

...

Ao utilizar a API a experiência é mais complexa porém mais rápida, o fluxo é feito em 6 requisições que podem ser encontradas em nosso Swagger, essas requisições são utilizadas para facilitar o uso de usuários que {espaço para completar}

Informações

Documentação no swagger: Api publica para integração

...

  • O filtro de relatórios é passado dessa forma ao final da URL:
    ?q={nome-do-Relatorio}

  • 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. 

    A resposta dessa chamada retornará um código HTTP 200 e o ID do(s) relatório(s) pesquisado(s), o displayName que é o nome de criação, a description e o navigationFolderId que informa se aquele relatório pertence a alguma pasta, se pertencer é mostrado o ID da pasta, se não, é mostrado 'Null'.

    Exemplo de Resposta:

    Bloco de código
    themeRDark
    titleResponde Body
    linenumberstrue
    [
        {
            "id": "1aa11111-1aa1-1aaa-1a1a-aa1aa1a11a11",
            "displayName": "Relatorio",
            "description": "Relatório utilizado para exemplificar",
            "navigationFolderId": 1
        }
    ]

Busca de Parâmetros

...

Nessa requisição é possivel visualizar os parâmetros cadastrados no relatório pesquisado.

...

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.

...

  • A resposta é preenchida com as informações do relatório desejado e com as informações retiradas do token.


    Exemplo de resposta:

    Bloco de código
    themeRDark
    titleResponde Body
    linenumberstrue
    {
        "viewer": "http://localhost:7017/reportsV2/myreports/document-view/{reportId}?access_token={access_token}&refresh_token={refresh_token}&scope={scope}&token_type={token_type}&expires_in={expires_in}&hidemenus=true"
    }
    
    

QueryString

...

A querystring no TReports é utilizada para visualizar o sistema sem que mostre seus menus.

...