Este método permite ao usuário recuperar a lista de processamentos em batch solicitados pelo mesmo, com dados detalhados sobre cada um dos processos.
Funcionamento
A partir do token de acesso fornecido, todos os jobs de processamento em batch atualmente em andamento são recuperados, com informações detalhadas (as mesmas que podem ser vistas no método GetJobDetails) dos mesmos. Os retornos são páginados de acordo com o tamanho da página definido na chamada.
Parâmetro Opcional - ShowHistoricalJobs
Caso queira recuperar também informações sobre jobs históricos, basta incluir na request o campo ShowHistoricalJobs com valor true. Confira o body request do exemplo "ListJobs + HistoricalJobs" ao lado.
Descrição dos campos de retorno do objeto principal
| Campo | Descrição |
|---|---|
| TotalNumberOfCurrentJobs | Quantidade total de jobs que estão atualmente em execução |
| TotalNumberOfJobs | Quantidade total de jobs já submetidos pelo usuário |
| Jobs | Lista de objetos com informações detalhadas sobre os jobs do usuário |
Descrição dos campos de retorno do objeto de detalhes do processamento
| Campo | Descrição |
|---|---|
| JobId | Identificador único do job |
| JobName | Nome do job |
| JobUserName | Usuário associado ao token |
| JobDomain | Domínio associado ao token |
| CurrentJobStatus | Estágio (status) atual do job |
| StatusPercentageComplete | Percentual de completude do estágio atual do job |
| TotalRecords | Quantidade total de registros enviados na entrada da consulta |
| TotalQueriedRecords | Quantidade total de registros consultados |
| TotalParsedRecords | Quantidade total de registros parseados |
| TotalQueryErrors | Quantidade total de erros de consulta ocorridos |
| TotalParsingErrors | Quantidade total de erros de parsing ocorridos |
| FirstQueryItem | Representação em string do objeto JSON referente a primeira consulta realizada no job |
| QueriedAPI | Qual API foi utilizada na execução desse job |
| LastUpdateDate | Data de última atualização do status do job |
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 foram pausadas 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 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 |
| -1200 | UNEXPECTED ERROR. PLEASE CONTACT OUR SUPPORT TEAM | Ocorreu algum erro inesperado. Entre em contato com nossa equipe de atendimento |
BODY raw
{
"PageSize": 100,
"PageNumber": 2
}