Job Router Operations - Unassign Job

Serviço:

Communication

Versão da API:

2023-11-01

Cancelar a atribuição de um trabalho.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
assignmentId	path	True	string	ID de uma tarefa de trabalho.
endpoint	path	True	string	URI do recurso de Comunicação
jobId	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
suspendMatching	boolean	Se SuspendMatching for true, um trabalho não será enfileirado para correspondência nova com um trabalho.

Respostas

Nome	Tipo	Description
200 OK	UnassignJobResult	A solicitação foi bem-sucedida.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Exemplos

Un-assign a job

Solicitação de exemplo

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 de exemplo

Código de status:

200

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

Definições

Nome	Description
Azure.Core.Foundations.Error	O objeto de erro.
Azure.Core.Foundations.ErrorResponse	Uma resposta que contém detalhes do 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.
UnassignJobOptions	Solicitar conteúdo para cancelar a atribuição de um trabalho.
UnassignJobResult	Conteúdo de resposta após um trabalho ter sido não atribuído com êxito.

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	Azure.Core.Foundations.Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
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 do erro.
target	string	O destino do erro.

Azure.Core.Foundations.ErrorResponse

Uma resposta que contém detalhes do erro.

Nome	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 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	Azure.Core.Foundations.InnerError	Erro interno.

UnassignJobOptions

Solicitar conteúdo para cancelar a atribuição de um trabalho.

Nome	Tipo	Description
suspendMatching	boolean	Se SuspendMatching for true, um trabalho não será enfileirado para correspondência nova com um trabalho.

UnassignJobResult

Conteúdo de resposta após um trabalho ter sido não atribuído com êxito.

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