post
https://plataforma.bigdatacorp.com.br/lote/obterDetalhes
Este método permite ao usuário recuperar informações detalhadas sobre o progresso de execução de qualquer job que tenha sido submetido para execução.
Funcionamento
A partir do identificador do job fornecido, é recuperado o status atual referente ao estágio de execução do mesmo, bem como informações estatísticas relacionadas à execução, como: o percentual de completude, o tempo estimado de execução e o custo estimado de execução do processamento do arquivo para o cliente.
Retorno
A tabela a seguir descreve os campos que são retornados por essa requisição.
| Campo | Descrição |
|---|---|
| JobId | Identificador do job (igual ao fornecido na entrada) |
| StatusCode | Código de resultado da chamada |
| ExternalErrorMessage | Descrição do erro ocorrido durante a execução do job, se houver |
| StatusMessage | Mensagem descritiva de resultado da chamada |
| TotalExecutionTime | Tempo total de execução da requisição no servidor |
| RequestTimestamp | Data e hora do término da execução da requisição no servidor |
| CurrentJobStatus | Status de execução atual do job |
| TotalRecords | Quantidade total de registros que devem ser processados |
| PercentComplete | Percentual de consultas já executadas em relação ao total de registros que devem ser processados |
| ErrorPercent | Percentual de consultas que resultaram em erro |
| ElapsedTime | Tempo total decorrido do início da execução até a consulta (ou o término, caso o job já esteja encerrado) |
| EstimatedTotalTime | Tempo estimado de execução, considerando o tempo decorrido até o momento da consulta |
| EstimatedJobCost | Custo estimado de execução, calculado através da API de preços |
| OutputFileName | Nome do arquivo de saída. Para processos finalizados, o link para download do resultado |
Status Possíveis do Processo
A tabela a seguir descreve os valores possíveis do campo CurrentJobStatus e o significado de cada um desses valores.
| Valor | Descrição |
|---|---|
| pending | O job foi salvo no banco de dados, mas nenhum processamento foi realizado em cima do mesmo |
| loading | O job está sendo carregado para processamento nas filas de consulta |
| loaded | O job foi carregado corretamente para processamento nas filas de consulta, e o usuário já pode comandar o começo da sua execução |
| querying | O job está sendo consultado |
| parallel_limit_reached | O job está sendo consultado pelo número máximo de processos em paralelo disponíveis no momento. É equivalente ao valor querying |
| paused | A execução das consultas do job foi suspensas até que o usuário comande sua retomada |
| queried | As consultas do job terminaram, e ele está aguardando o processo de parseamento para gerar os arquivos de saída |
| parsing | Os resultados das consultas do job estão sendo parseados para gerar os arquivos de saída |
| done | A execução do job foi finalizada e o arquivo final de resultado foi enviado |
| cancelled | A execução do job foi cancelada pelo usuário |
Códigos de Status
A tabela a seguir descreve os possíveis códigos e mensagens de retorno.
| Código | Mensagem | Descrição |
|---|---|---|
| 0 | OK | Execução com sucesso |
| -1 | INVALID AUTHENTICATION PARAMETERS | O token de acesso fornecido na entrada é inválido |
| -2 | BAD REQUEST FORMAT | O request enviado não está bem formatado |
| -108 | INVALID JOB ID | O identificador do job passado na entrada é inválido |
| -1200 | UNEXPECTED ERROR. PLEASE CONTACT OUR SUPPORT TEAM | Ocorreu algum erro inesperado. Entre em contato com nossa equipe de atendimento |
BODY raw
{
JobId": "[IDENTIFICADOR ÚNICO DO JOB]"
}