Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 20 Current »

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.

image-20241017-170250.pngimage-20241015-172831.png

  1. Enviar uma requisição GET para /relatorio

image-20241015-173158.png
 Usaremos o "identificadorRelatorio": 30 como exemplo:


  1. Enviar uma requisição GET para /relatorio/{idRelatorio}/parametros

image-20241015-173336.pngimage-20241016-194744.png
  1. Enviar uma requisição POST para /relatorio/gerar fornecendo os valores dos parâmetros

image-20241016-195007.png

Retorna um "idSolicitacao"

image-20241015-175743.png
  1. Enviar uma requisição GET para /relatorio/status/{idSolicitacao}

image-20241015-180136.png
  • Os possíveis “status” são os seguintes:

  1. "status": "RECEBIDO" - Solicitação de geração recebida e aguardando processamento.

image-20241015-180958.png
  1. status": "PROCESSADO_SUCESSO" - Solicitação processada com sucesso e retorna o relatório gerado em pronto para ser utilizado em Base64

image-20241015-180017.png

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:

 "identificadorRelatorio": 147

image-20241016-195630.png

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"

image-20241016-195921.png

API Explorer (Swagger)

  • No labels