Os sistemas que estão integrados aos processos batch da plataforma CobranSaaS podem verificar o andamento e a conclusão da execução dos processos batch correspondentes às importações através do método Batch API - Listar batches, cuja documentação está disponível no link seudominio.cobransaas.com.br/#/docs-api/batch/api-batch, onde a expressão "seudominio" deverá ser substituída nesta URL pelo domínio utilizado por sua empresa na plataforma CobranSaaS.
Conforme consta na documentação deste método, estão disponíveis parâmetros de entrada que podem ser informados na chamada do método para restringir a lista de processos batch retornados. Os parâmetros dataProcessamentoInicio e dataProcessamentoFim podem ser utilizados para pesquisar processos batch cuja execução tenha sido solicitada em um determinado período. O parâmetro situacao (CONCLUIDO, INICIANDO, INICIADO, PARANDO, PARADO, FALHOU, ABANDONADO e DESCONHECIDO) pode ser utilizado para retornar apenas processos batch que estejam em uma determinada situação de execução.
Os sistemas que estão integrados aos processos batch da plataforma CobranSaaS também podem verificar o andamento e a conclusão da execução de um processo batch específico correspondente à uma importação, cuja identificação (id) deve ser informada na URL de chamada do método Batch API - Buscar batch, cuja documentação está disponível no link seudominio.cobransaas.com.br/#/docs-api/batch/api-batch-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 de ambos os métodos citados acima, os mesmos retornam, para cada processo batch correspondente à uma importação, 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 quantidade de registros lidos no atributo quantidadeLidos, a quantidade de registros gravados no atributo quantidadeGravados, a quantidade de registros ignorados no atributo quantidadeIgnorados, 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 de importação, a mensagem de erro correspondente, no atributo mensagemSaida. Somente no caso do método Batch API - Listar batches, o tipo de entidade importada através do processo batch é retornado no atributo nome.
Exemplos de chamada e de retorno destes métodos da Batch API constam na pasta Batch API do arquivo Processos Batch.postman_collection.json, disponível como anexo em Integrando Sistemas com os Processos Batch.
0 Comentários