Job Router Operations - Cancel Job

Služba:

Communication

Verze rozhraní API:

2023-11-01

Odešle žádost o zrušení existující úlohy podle ID při zadávání důvodu zrušení bezplatného formuláře.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
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
dispositionCode	string	Označuje výsledek úlohy a naplní toto pole vlastními hodnotami. Pokud není zadaný, nastaví se výchozí hodnota "Cancelled" (Zrušeno).
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

Cancels a job

Submits request to cancel an existing job

Cancels a job

Ukázkový požadavek

HTTP

POST https://contoso.westus.communications.azure.com/routing/jobs/8780b28c-7079-4de1-9143-4d369289e958:cancel?api-version=2023-11-01

{}

Ukázková odpověď

Stavový kód:

200

{}

Submits request to cancel an existing job

Ukázkový požadavek

HTTP

POST https://contoso.westus.communications.azure.com/routing/jobs/8780b28c-7079-4de1-9143-4d369289e958:cancel?api-version=2023-11-01

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.
CancelJobOptions	Žádost o datovou část pro zrušení úlohy

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.

CancelJobOptions

Žádost o datovou část pro zrušení úlohy

Name	Typ	Description
dispositionCode	string	Označuje výsledek úlohy a naplní toto pole vlastními hodnotami. Pokud není zadaný, nastaví se výchozí hodnota "Cancelled" (Zrušeno).
note	string	Poznámka, která se připojí k kolekci poznámek úlohy s aktuálním časovým razítkem.