Árvore de páginas

Versões comparadas

Chave

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

...

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

OPTIONS: /api/reports/v1/resources/{id-do-relatório}/generate

O retorno ifnorma o name do parâmetro, displayName, type e se ele é multiValue.

Exemplo de resposta:


Bloco de código
themeRDark
titleResponde Body
[
  {
    "name": "parametro",
    "displayName": "parametro",
    "type": "string",
    "multiValue": true
  }
]


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.

...

  • O 'generate?ttl=' é o tempo em minutos em que o documento gerado ficará disponível, vindo por padrão o valor 1440 e sendo o mínimo aceitável 1 minuto. 
  • 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 retorno dessa requisição é um código HTTP 200 e informa o ID de geração que será utilizado para fazer o download do relatório desejado.

...