Documentação Técnica

Cancelar Execução

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.

CampoObrigatório?Valores PossíveisDescrição
JobIdSimIdentificador do job que deve ser suspendidoUma URL válida e accessível pelo processo

Retorno

A tabela a seguir descreve os campos do objeto de retorno desse método.

CampoDescrição
JobIdIdentificador do job fornecido na entrada
StatusCodeCódigo de resultado da chamada
StatusMessageMensagem descritiva de resultado da chamada
TotalExecutionTimeTempo total de execução da requisição no servidor
RequestTimestampData 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ódigoMensagemDescrição
0OKExecução com sucesso
-1INVALID AUTHENTICATION PARAMETERSO token de acesso fornecido na entrada é inválido
-2BAD REQUEST FORMATO request enviado não está bem formatado
-108INVALID JOB IDO identificador do job passado na entrada é inválido
-109INVALID JOB STATUS FOR OPERATIONO job selecionado não pode ser suspendido ou cancelado devido ao seu status atual
-1200UNEXPECTED ERROR. PLEASE CONTACT OUR SUPPORT TEAMOcorreu algum erro inesperado. Entre em contato com nossa equipe de atendimento

BODY raw

{
	"JobId": "[IDENTIFICADOR ÚNICO DO JOB]"
}
Language
Authorization
Click Try It! to start a request and see the response here!