Job Router Operations - Close Job

Dienst:

Communication

API-Version:

2023-11-01

Schließt einen abgeschlossenen Auftrag.

POST {endpoint}/routing/jobs/{jobId}/assignments/{assignmentId}:close?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
closeAt	string	Wenn nicht angegeben, wird die Arbeitskapazität sofort zusammen mit einer JobClosedEvent-Benachrichtigung freigegeben. Wenn angegeben, wird die Arbeitskapazität zusammen mit einer JobClosedEvent-Benachrichtigung zu einem späteren Zeitpunkt in UTC freigegeben.
dispositionCode	string	Gibt das Ergebnis eines Auftrags an, füllen Sie dieses Feld mit Ihren eigenen benutzerdefinierten Werten auf.
note	string	Beachten Sie, dass die Notizensammlung eines Auftrags mit dem aktuellen Zeitstempel angefügt wird.

Antworten

Name	Typ	Beschreibung
200 OK	object	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

Closes a completed job

Beispielanforderung

HTTP

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

{
  "dispositionCode": "JobCompleted.",
  "note": "Closing job"
}

Beispiel für eine Antwort

Statuscode:

200

{}

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.
CloseJobOptions	Anforderungsnutzlast für schließende Aufträge

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.

CloseJobOptions

Anforderungsnutzlast für schließende Aufträge

Name	Typ	Beschreibung
closeAt	string	Wenn nicht angegeben, wird die Arbeitskapazität sofort zusammen mit einer JobClosedEvent-Benachrichtigung freigegeben. Wenn angegeben, wird die Arbeitskapazität zusammen mit einer JobClosedEvent-Benachrichtigung zu einem späteren Zeitpunkt in UTC freigegeben.
dispositionCode	string	Gibt das Ergebnis eines Auftrags an, füllen Sie dieses Feld mit Ihren eigenen benutzerdefinierten Werten auf.
note	string	Beachten Sie, dass die Notizensammlung eines Auftrags mit dem aktuellen Zeitstempel angefügt wird.