Este método permite ao usuário cancelar a execução de um job que está sendo processado.
Funcionamento
A partir do JobId fornecido na entrada, que deve ser um identificador válido e associado com algum job desse usuário, o
método irá cancelar toda a execução desse job. É importante lembrar que, após o cancelamento, não é possível retomar a
execução do ponto aonde ela parou. Caso seja necessário retomar a execução em um momento posterior, utilize o método de
pausa, descrito acima.
Parâmetros de Entrada
A tabela a seguir descreve os parâmetros de entrada deste método, indicando se são obrigatórios ou não, e os valores possíveis para os campos com valores pré-definidos.
| Campo | Obrigatório? | Valores Possíveis | Descrição |
|---|---|---|---|
| JobId | Sim | Identificador do job que deve ser suspendido | Uma URL válida e accessível pelo processo |
Retorno
A tabela a seguir descreve os campos do objeto de retorno desse método.
| Campo | Descrição |
|---|---|
| JobId | Identificador do job fornecido na entrada |
| StatusCode | Código de resultado da chamada |
| 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 |
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 |
| -109 | INVALID JOB STATUS FOR OPERATION | O job selecionado não pode ser suspendido ou cancelado devido ao seu status atual |
| -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]"
}