Job Router Operations - Close Job

Service:

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	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

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

Antworten

Name	Typ	Beschreibung
200 OK	object	Die Anforderung wurde erfolgreich durchgeführt.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Eine unerwartete Fehlerantwort. Headers x-ms-error-code: string

Beispiele

Closes a completed job

Sample Request

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"
}

Sample Response

Status code:

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	Einer der vom Server definierten 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 für Menschen 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	Einer der vom Server definierten Fehlercodes.
innererror	Azure.Core.Foundations.InnerError	Innerer Fehler.

CloseJobOptions

Anforderungsnutzlast für schließende Aufträge

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