Obtendo Informações sobre o Processamento das Interfaces

Os sistemas que estão integrados aos processos batch da plataforma CobranSaaS podem verificar o andamento e a conclusão da execução de um processo batch específico correspondente à uma interface, cuja identificação (id) deve ser informada na URL de chamada do método Interfaces API - Buscar processo interface, cuja documentação está disponível no link seudominio.cobransaas.com.br/#/docs-api/interfaces/api-interfaces-processar-id, onde a expressão "seudominio" deverá ser substituída nesta URL pelo domínio utilizado por sua empresa na plataforma CobranSaaS.

Conforme detalhado na documentação do método, o mesmo retorna, para o processo batch correspondente à uma interface, o identificador do processo batch no atributo id, a data e hora de criação do processo batch no atributo dataCriacao, a data e hora de início e de término da execução do processo batch nos atributos dataInicio e dataFim, a data e hora da última atualização da execução do processo batch no atributo dataUltimaAtualizacao, o tempo de duração da execução do processo batch no atributo duracao, a quantidade de registros lidos no atributo quantidadeLidos, a quantidade de registros gravados no atributo quantidadeGravados, a quantidade de registros ignorados no atributo quantidadeIgnorados, a quantidade total de registros no atributo quantidadeTotal, o percentual de execução do processo batch no atributo percentual, a situação atual da execução do processo batch no atributo situacao (CONCLUIDO, INICIANDO, INICIADO, PARANDO, PARADO, FALHOU, ABANDONADO, DESCONHECIDO) e, caso tenha ocorrido algum erro durante a execução do processo batch da interface, a mensagem de erro correspondente, no atributo mensagemSaida. No objeto configInterface são retornadas todas as informações da configuração da interface do processo batch, descritas em Obtendo as Configurações das Interfaces.

Exemplos de chamada e de retorno deste método da Interfaces API constam na pasta Interfaces API do arquivo Processos Batch.postman_collection.json, disponível como anexo em Integrando Sistemas com os Processos Batch.