Job Router Operations - Unassign Job

Servizio:

Communication

Versione API:

2023-11-01

Annullare l'assegnazione di un processo.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
assignmentId	path	True	string	ID di un'assegnazione di processo.
endpoint	path	True	string	URI della risorsa di comunicazione
jobId	path	True	string	ID di un processo.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Tipo	Descrizione
suspendMatching	boolean	Se SuspendMatching è true, un processo non viene accodato per la ri-corrispondenza con un ruolo di lavoro.

Risposte

Nome	Tipo	Descrizione
200 OK	UnassignJobResult	La richiesta ha avuto esito positivo.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Risposta di errore imprevista. Intestazioni x-ms-error-code: string

Sicurezza

AadOauth2Auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: accessCode
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize
URL token: https://login.microsoftonline.com/common/oauth2/token

Ambiti

Nome	Descrizione
https://communication.azure.com/.default

Esempio

Un-assign a job

Esempio di richiesta

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
}

Risposta di esempio

Codice di stato:

200

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

Definizioni

Nome	Descrizione
Azure.Core.Foundations.Error	Oggetto error.
Azure.Core.Foundations.ErrorResponse	Risposta contenente i dettagli dell'errore.
Azure.Core.Foundations.InnerError	Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One , https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
UnassignJobOptions	Richiedere il payload per annullare l'assegnazione di un processo.
UnassignJobResult	Payload della risposta dopo che un processo è stato assegnato correttamente.

Azure.Core.Foundations.Error

Object

Oggetto error.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
details	Azure.Core.Foundations.Error[]	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innererror	Azure.Core.Foundations.InnerError	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

Azure.Core.Foundations.ErrorResponse

Object

Risposta contenente i dettagli dell'errore.

Nome	Tipo	Descrizione
error	Azure.Core.Foundations.Error	Oggetto error.

Azure.Core.Foundations.InnerError

Object

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One , https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
innererror	Azure.Core.Foundations.InnerError	Errore interno.

UnassignJobOptions

Object

Richiedere il payload per annullare l'assegnazione di un processo.

Nome	Tipo	Descrizione
suspendMatching	boolean	Se SuspendMatching è true, un processo non viene accodato per la ri-corrispondenza con un ruolo di lavoro.

UnassignJobResult

Object

Payload della risposta dopo che un processo è stato assegnato correttamente.

Nome	Tipo	Descrizione
jobId	string	ID di un processo non assegnato.
unassignmentCount	integer (int32)	Numero di volte in cui un processo non è assegnato. Al massimo 3.