Job Router Operations - Close Job

Služba:

Communication

Verze rozhraní API:

2023-11-01

Zavře dokončenou úlohu.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
assignmentId	path	True	string	ID přiřazení úlohy.
endpoint	path	True	string	Identifikátor URI vašeho komunikačního prostředku
jobId	path	True	string	ID úlohy.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Typ	Description
closeAt	string	Pokud není k dispozici, pracovní kapacita se okamžitě uvolní spolu s oznámením JobClosedEvent. Pokud je k dispozici, pracovní kapacita se uvolní spolu s oznámením JobClosedEvent v budoucnu v UTC.
dispositionCode	string	Označuje výsledek úlohy a naplní toto pole vlastními hodnotami.
note	string	Poznámka, která se připojí k kolekci poznámek úlohy s aktuálním časovým razítkem.

Odpovědi

Name	Typ	Description
200 OK	object	Požadavek byl úspěšný.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Neočekávaná chybová odpověď Hlavičky x-ms-error-code: string

Zabezpečení

AadOauth2Auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: accessCode
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize
URL tokenu: https://login.microsoftonline.com/common/oauth2/token

Rozsahy

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

Příklady

Closes a completed job

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

200

{}

Definice

Name	Description
Azure.Core.Foundations.Error	Objekt chyby.
Azure.Core.Foundations.ErrorResponse	Odpověď obsahující podrobnosti o chybě.
Azure.Core.Foundations.InnerError	Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní API Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
CloseJobOptions	Žádost o datovou část pro zavření úloh

Azure.Core.Foundations.Error

Objekt chyby.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
details	Azure.Core.Foundations.Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	Azure.Core.Foundations.InnerError	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message	string	Čitelné znázornění chyby člověkem.
target	string	Cíl chyby.

Azure.Core.Foundations.ErrorResponse

Odpověď obsahující podrobnosti o chybě.

Name	Typ	Description
error	Azure.Core.Foundations.Error	Objekt chyby.

Azure.Core.Foundations.InnerError

Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní API Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
innererror	Azure.Core.Foundations.InnerError	Vnitřní chyba.

CloseJobOptions

Žádost o datovou část pro zavření úloh

Name	Typ	Description
closeAt	string	Pokud není k dispozici, pracovní kapacita se okamžitě uvolní spolu s oznámením JobClosedEvent. Pokud je k dispozici, pracovní kapacita se uvolní spolu s oznámením JobClosedEvent v budoucnu v UTC.
dispositionCode	string	Označuje výsledek úlohy a naplní toto pole vlastními hodnotami.
note	string	Poznámka, která se připojí k kolekci poznámek úlohy s aktuálním časovým razítkem.