Job Router Operations - Cancel Job
Envia a solicitação para cancelar um trabalho existente por ID ao fornecer o motivo do cancelamento de formulário livre.
POST {endpoint}/routing/jobs/{jobId}:cancel?api-version=2023-11-01Parâmetros de URI
| Nome | Em | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string |
Uri do recurso comunicação |
|
job
|
path | True |
string |
Id de um trabalho. |
|
api-version
|
query | True |
string |
A versão da API a ser usada para esta operação. |
Corpo da solicitação
| Nome | Tipo | Description |
|---|---|---|
| dispositionCode |
string |
Indica o resultado de um trabalho, preencha esse campo com seus próprios valores personalizados. Se não for fornecido, o valor padrão de "Cancelado" será definido. |
| note |
string |
Uma observação que será acrescentada à coleção Notes de um trabalho com o carimbo de data/hora atual. |
Respostas
| Nome | Tipo | Description |
|---|---|---|
| 200 OK |
object |
A solicitação foi bem-sucedida. |
| Other Status Codes |
Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string |
Exemplos
| Cancels a job |
| Submits request to cancel an existing job |
Cancels a job
Solicitação de exemplo
POST https://contoso.westus.communications.azure.com/routing/jobs/8780b28c-7079-4de1-9143-4d369289e958:cancel?api-version=2023-11-01
{}
Resposta de exemplo
{}Submits request to cancel an existing job
Solicitação de exemplo
POST https://contoso.westus.communications.azure.com/routing/jobs/8780b28c-7079-4de1-9143-4d369289e958:cancel?api-version=2023-11-01
Resposta de exemplo
{}Definições
| Nome | Description |
|---|---|
|
Azure. |
O objeto de erro. |
|
Azure. |
Uma resposta que contém detalhes do erro. |
|
Azure. |
Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
|
Cancel |
Solicite conteúdo para cancelar um trabalho. |
Azure.Core.Foundations.Error
O objeto de erro.
| Nome | Tipo | Description |
|---|---|---|
| code |
string |
Um de um conjunto definido pelo servidor de códigos de erro. |
| details |
Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado. |
|
| innererror |
Um objeto que contém informações mais específicas do que o objeto atual sobre o erro. |
|
| message |
string |
Uma representação legível pelo homem do erro. |
| target |
string |
O destino do erro. |
Azure.Core.Foundations.ErrorResponse
Uma resposta que contém detalhes do erro.
| Nome | Tipo | Description |
|---|---|---|
| error |
O objeto de erro. |
Azure.Core.Foundations.InnerError
Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
| Nome | Tipo | Description |
|---|---|---|
| code |
string |
Um de um conjunto definido pelo servidor de códigos de erro. |
| innererror |
Erro interno. |
CancelJobOptions
Solicite conteúdo para cancelar um trabalho.
| Nome | Tipo | Description |
|---|---|---|
| dispositionCode |
string |
Indica o resultado de um trabalho, preencha esse campo com seus próprios valores personalizados. Se não for fornecido, o valor padrão de "Cancelado" será definido. |
| note |
string |
Uma observação que será acrescentada à coleção Notes de um trabalho com o carimbo de data/hora atual. |