Job Router Operations - Unassign Job

Dienst:

Communication

API-Version:

2023-11-01

Aufheben der Zuweisung eines Auftrags.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
assignmentId	path	True	string	ID einer Auftragszuweisung.
endpoint	path	True	string	URI Ihrer Kommunikationsressource
jobId	path	True	string	ID eines Auftrags.
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
suspendMatching	boolean	Wenn "SuspendMatching" auf "true" festgelegt ist, wird kein Auftrag für den erneuten Abgleich mit einem Worker in die Warteschlange gestellt.

Antworten

Name	Typ	Beschreibung
200 OK	UnassignJobResult	Die Anforderung ist erfolgreich.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Unerwartete Fehlerantwort. Header x-ms-error-code: string

Sicherheit

AadOauth2Auth

Der Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: accessCode
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiche

Name	Beschreibung
https://communication.azure.com/.default

Beispiele

Un-assign a job

Beispielanforderung

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
}

Beispiel für eine Antwort

Statuscode:

200

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

Definitionen

Name	Beschreibung
Azure.Core.Foundations.Error	Das Fehlerobjekt.
Azure.Core.Foundations.ErrorResponse	Eine Antwort, die Fehlerdetails enthält.
Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
UnassignJobOptions	Anforderungsnutzlast für das Aufheben der Zuweisung eines Auftrags.
UnassignJobResult	Antwortnutzlast, nachdem ein Auftrag erfolgreich nicht zugewiesen wurde.

Azure.Core.Foundations.Error

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
details	Azure.Core.Foundations.Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

Azure.Core.Foundations.ErrorResponse

Eine Antwort, die Fehlerdetails enthält.

Name	Typ	Beschreibung
error	Azure.Core.Foundations.Error	Das Fehlerobjekt.

Azure.Core.Foundations.InnerError

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
innererror	Azure.Core.Foundations.InnerError	Innerer Fehler.

UnassignJobOptions

Anforderungsnutzlast für das Aufheben der Zuweisung eines Auftrags.

Name	Typ	Beschreibung
suspendMatching	boolean	Wenn "SuspendMatching" auf "true" festgelegt ist, wird kein Auftrag für den erneuten Abgleich mit einem Worker in die Warteschlange gestellt.

UnassignJobResult

Antwortnutzlast, nachdem ein Auftrag erfolgreich nicht zugewiesen wurde.

Name	Typ	Beschreibung
jobId	string	ID eines nicht zugewiesenen Auftrags.
unassignmentCount	integer	Die Häufigkeit, mit der ein Auftrag nicht zugewiesen wird. Maximal 3.