Geração de Relatórios via API Rest
- EDILSON SOARES DE OLIVEIRA JUNIOR (Unlicensed)
Serviço disponibilizado para que seja possível exportação de relatórios do e-Sfinge Online através da nossa API https://virtual.testing.tce.sc.gov.br/esfingeonline/swagger-ui.html
As solicitações de relatórios enviadas, serão encaminhadas a uma fila de geração e o processamento ocorrerá forma assíncrona.
Enviar uma requisição GET para /relatorio
Enviar uma requisição GET para /relatorio/{idRelatorio}/parametros
Enviar uma requisição POST para /relatorio/gerar fornecendo os valores dos parâmetros
Retorna um "idSolicitacao"
Enviar uma requisição GET para /relatorio/status/{idSolicitacao}
Os possíveis “status” são os seguintes:
"status": "RECEBIDO" - Solicitação de geração recebida e aguardando processamento.
status": "PROCESSADO_SUCESSO" - Solicitação processada com sucesso e retorna o relatório gerado em pronto para ser utilizado em Base64
3. "status": "PROCESSADO_ERRO_INTERNO" - Ocorreu algum erro na geração do relatório, favor entrar em contato com o nosso helpdesk e informe detalhes do erro e o idSolicitacao.
Observações sobre alguns parâmetros:
Em "tipoRelatorio" deve ser informado o formato do relatório que deseja exportar.
As opões disponíveis são 0 e 1, sendo 0 para geração do relatório em formato XLSX e 1 para geração em formato JSON.
O valor do "parametroNome": "IDENTIFICADOR_UNIDADE_GESTORA" é o Código da Unidade Gestora que o dado será exportado.
Relatórios que tem parâmetros com opções:
Exemplo:
Importante!
É possível realizar a solicitação para todos os valores de identificadores disponíveis, porém os valores devem ser informados separados por vírgula.
Exemplo:
"valor": "1,2,3,4,5"