Job Router Operations - Unassign Job

Serviço:

Communication

Versão da API:

2023-11-01

Anular a atribuição de um trabalho.

POST {endpoint}/routing/jobs/{jobId}/assignments/{assignmentId}:unassign?api-version=2023-11-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
assignmentId	path	True	string	ID de uma tarefa.
endpoint	path	True	string	URI do recurso de Comunicação
jobId	path	True	string	ID de um emprego.
api-version	query	True	string	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Tipo	Description
suspendMatching	boolean	Se SuspendMatching for verdadeiro, uma tarefa não é colocada em fila para voltar a fazer a correspondência com uma função de trabalho.

Respostas

Name	Tipo	Description
200 OK	UnassignJobResult	O pedido foi efetuada com êxito.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Exemplos

Un-assign a job

Pedido de amostra

HTTP

POST https://contoso.westus.communications.azure.com/routing/jobs/8780b28c-7079-4de1-9143-4d369289e958/assignments/1d5896f3-8b54-40be-82d3-910323f5e2af:unassign?api-version=2023-11-01

{
  "suspendMatching": false
}

Resposta da amostra

Código de estado:

200

{
  "jobId": "8780b28c-7079-4de1-9143-4d369289e958",
  "unassignmentCount": 1
}

Definições

Name	Description
Azure.Core.Foundations.Error	O objeto de erro.
Azure.Core.Foundations.ErrorResponse	Uma resposta que contém detalhes 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 Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
UnassignJobOptions	Pedir payload para anular a atribuição de uma tarefa.
UnassignJobResult	Payload de resposta depois de uma tarefa ter sido não atribuída com êxito.

Azure.Core.Foundations.Error

O objeto de erro.

Name	Tipo	Description
code	string	Um dos conjuntos de códigos de erro definidos pelo servidor.
details	Azure.Core.Foundations.Error[]	Uma série de detalhes sobre erros específicos que levaram a este erro comunicado.
innererror	Azure.Core.Foundations.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 por humanos do erro.
target	string	O destino do erro.

Azure.Core.Foundations.ErrorResponse

Uma resposta que contém detalhes de erro.

Name	Tipo	Description
error	Azure.Core.Foundations.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 Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Tipo	Description
code	string	Um dos conjuntos de códigos de erro definidos pelo servidor.
innererror	Azure.Core.Foundations.InnerError	Erro interno.

UnassignJobOptions

Pedir payload para anular a atribuição de uma tarefa.

Name	Tipo	Description
suspendMatching	boolean	Se SuspendMatching for verdadeiro, uma tarefa não é colocada em fila para voltar a fazer a correspondência com uma função de trabalho.

UnassignJobResult

Payload de resposta depois de uma tarefa ter sido não atribuída com êxito.

Name	Tipo	Description
jobId	string	ID de um trabalho não atribuído.
unassignmentCount	integer	O número de vezes que uma tarefa não é atribuída. No máximo 3.