Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.

...

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

...

Expand
titleUsaremos o "identificadorRelatorio": 30 como exemplo:

View file
namerelatorio_30.json

...

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

...

Em "tipoRelatorio" 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.

...

  1. Enviar uma requisição POST para /relatorio/gerar fornecendo os valores dos parâmetros

...

  1. Enviar uma requisição GET para /relatorio/status/{idSolicitacao}

...

  • Os possíveis “status” são os seguintes:

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

...

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.image-20241015-180634.pngImage Removed

...

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:

Expand
title"identificadorRelatorio": 147

View file
namerelatorio_147.json

...

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"

...

API Explorer (Swagger)