Geração de Relatórios via API Rest
Serviço disponibilizado para que seja possível exportação de relatórios do e-Sfinge Online através da nossa API SWAGGER UI
As requisições de exportação de relatórios serão encaminhadas para uma fila de processamento e a geração será realizada de forma assíncrona, permitindo maior escalabilidade e desempenho.
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: Geração do relatório em formato XLSX
1: Geração do relatório em formato JSON
3: Geração do relatório em formato CSV
4: Geração do relatório em formato PDF
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": 230
"parametroNome": "tipo_operacao_credito_trib_transferencia"
{
"parametroNome": "tipo_operacao_credito_trib_transferencia",
"descricaoParametro": "Tipo de Operação",
"valor": "Valor para o parâmetro",
"opcoes": [
{
"identificador": 1,
"descricao": "1 - Lançamento Inicial do Crédito Tributário (Não Inscrito em Dívida Ativa)"
},
{
"identificador": 3,
"descricao": "3 - Dívida Ativa (Inscrição ou Saldos de Exercícios Anteriores)"
},
{
"identificador": 41,
"descricao": "4 - Lançamento Inicial (Implantação de Saldos em virtude de migração de Sistema de TI)"
},
{
"identificador": 42,
"descricao": "4 - Dívida Ativa (Implantação de Saldos em virtude de migração de Sistema de TI)"
},
{
"identificador": 51,
"descricao": "5 - Lançamento Inicial (Transferência de Crédito Tributário entre Contribuintes)"
},
{
"identificador": 52,
"descricao": "5 - Dívida Ativa (Transferência de Crédito Tributário entre Contribuintes)"
}
],
"parametroTipo": "STRING",
"indicativoObrigatorio": false
}Quando o parâmetro for do tipo STRING e tiver OPÇÕES, você pode enviar os identificadores que deseja.
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.
"valor": "TODOS", não será aceito!
Relatorios que tem "parametroNome": "VALOR", utilizar o campo "descricaoParametro" para identificar qual o "valor" deve ser informado.
Exemplo{ "parametroNome": "VALOR", "descricaoParametro": "Número Contrato", "valor": "Valor para o parâmetro", "opcoes": null, "parametroTipo": "STRING", "indicativoObrigatorio": false }
Relatorios que tem "parametroNome": "CHECKBOX", "parametroTipo": "BOOLEAN" utilizar o campo "descricaoParametro" para identificar se o "valor" a ser informado é 1=True ou 0=False.
Exemplo{ "parametroNome": "CHECKBOX", "descricaoParametro": "Agrupar Resultados", "valor": "Valor para o parâmetro", "opcoes": null, "parametroTipo": "BOOLEAN", "indicativoObrigatorio": false }
Geração de Sub-Relatórios via API Rest
Geração de Relatórios - Melhoria no Processamento de Arquivo com Grande Volume de Dados.