Histórico da Página

...

É apresentado um cenário em que o relatório já esteja previamente cadastrado, e para prosseguirmos com o fluxo é necessário que tenhamos a informação do identificador do relatório.

A partir dai passaremos pelas etapa de busca de um relatório, Iniciaremos o fluxo buscando pelo identificador do relatório (id) na api de busca de relatório onde seguiremos nas etapas de busca de parâmetros, solicitação de geração e  finalizando na api de download do arquivo gerado.

é possível fazer sua busca pelo sistema, ela pode ser feita pelo respectivo nome ou descrição do relatório ou pela pasta que ele pertence, sendo necessário apenas especificar corretamente qual tipo da busca desejada conforme mostra na documentação no Swagger, também é possível fazer a procura dos parâmetros do relatório, parâmetros esses que serão necessários atribuir valor no momento da geração para se concluir com sucesso, feito isso, o download desse relatório ficará disponibilizado em diversos formatos no tempo que foi especificado.

Busca de Relatório Relatório

...

A "busca é utilizada para encontrar o relatório desejado, sendo possível buscar aqueles 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 criados pelo próprio usuáriode sua própria criação, compartilhados via pasta ou via compartilhamento único. Assim como é feito na interface do sistema, a busca já pode ser realizada ao possui a funcionalidade de filtro onde é necessário enviar no mínimo 3 caracteres para pesquisa, todos dessa forma, os relatórios que tiverem esses caracteres em comum serão retornados. 

Detalhes da implementação são encontrados no Para detalhes procure pelo endpoint abaixo:

O

retorno apresentado lista os relatórios do sistemaAbaixo temos um exemplo da lista de relatórios retornados pela api, utilizaremos o relatório com id: a4127383-3229-420f-bd47-c795c2af5ebd como exemplo para dar continuidade em nosso fluxo de uso na próxima etapa.

[	
	{
        "id": "a4127383-3229-420f-bd47-c795c2af5ebd",
        "displayName": "Recibo de Fatura (JU203b) ",
        "description": "Recibo de Fatura (JU203b) - Grupo de Estudos",
        "navigationFolderId": 1
    },
    {
        "id": "cd767d3f-ec71-4c1a-8143-c6645dd8f63c",
        "displayName": "Recibo de Fatura\"",
        "description": "Recibo de Fatura\"",
        "navigationFolderId": null
    },
    {
        "id": "e30288af-6989-4a30-9792-3c7f5735db56",
        "displayName": "Relatorio sem fitro de casos",
        "description": null,
        "navigationFolderId": null
    }
]

Para seguirmos o fluxo apresentado iremos utilizar o relatório de ID: a4127383-3229-420f-bd47-c795c2af5ebd.

Busca de

...

Parâmetros 

...

É importante lembrar que um relatório pode conter parâmetros para sua geração, caso não tenha ciência se conhecimento da existência de parâmetros para o relatório possui algum parâmetroselecionado, basta consultar o endpoint:a api abaixo.

A requisição irá retornar "busca de parâmetros" lista todos os parâmetros necessários para fazer a solicitação do relatório. que o relatório posso ser executado, utilizaremos o valor do campo "name" de cada parâmetro para a próxima etapa.

[
    {
        "name": "pCodEscr",
        "displayName": "Código do Escritório",
        "type": "string",
        "multiValue": true
    },
    {
        "name": "pCodFatura",
        "displayName": "Código da Fatura",
        "type": "string",
        "multiValue": false
    },
    {
        "name": "pNomeSocio",
        "displayName": "Nome do Sócio da Fatura",
        "type": "string",
        "multiValue": false
    }
]

Utilizaremos a resposta para o campo "Name" para fazer a associação ao valor exigido.

Gerando um Relatório

Neste momento temos o ID do relatório e o name do parâmetros necessários para geração (pCodEscr, pCodFatura e pNomeSocio).

Solicitar Geração de um Arquivo

...

O endpoint "Solicitar Geração de um Arquivo" é uma api utilizada para solicitar a geração de um arquivo para o relatório escolhido, desde o início do fluxo coletamos informações importantes para utilização deste endpoint. Utilizaremos o identificador do relatório id: a4127383-3229-420f-bd47-c795c2af5ebd e o valor da propriedade "name" de cada parâmetro necessário para geração "pCodEscr", "pCodFatura" e "pNomeSocio".

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

No caso do exemplo, é possível Olhando a requisição anterior podemos perceber que o parâmetro "pCodEscr" é multi valorado ("multiValue: true), isso significa que ", ou seja, o parâmetro recebe uma lista de valores.

Para solicitar a geração utilizamos o Detalhes da implementação são encontrados no endpoint abaixo:

Nesta requisição, como mencionado anteriormente, utilizaremos os dados infomados. Cada solicitação é exclusiva de acordo com os parâmetros necessários, neste caso apresentamos a forma em que os parâmetros serão enviados no corpo (body) da requisição conforme o cenário apresentado."body" os parâmetros e seus respectivos valores conforme abaixo:

{
  "pCodEscr": ["SP001", "SP001"],
  "pCodFatura": "000000180",
  "pNomeSocio": "Isabelle Silva"
}

O retorno dessa requisição é o ID de geraçãoCaso a requisição seja feita corretamente, será apresentado como retorno o identificador de geração "generationId"  que utilizaremos na proxima etapa.

...