Job Router Operations - Cancel Job

Tjänst:

Communication

API-version:

2023-11-01

Skickar en begäran om att avbryta ett befintligt jobb med ID när du anger orsaken till avbokning av kostnadsfritt formulär.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string	Uri för din kommunikationsresurs
jobId	path	True	string	Id för ett jobb.
api-version	query	True	string	DEN API-version som ska användas för den här åtgärden.

Begärandetext

Name	Typ	Description
dispositionCode	string	Anger resultatet av ett jobb och fyller i det här fältet med dina egna anpassade värden. Om det inte anges anges standardvärdet "Avbrytd".
note	string	En anteckning som läggs till i ett jobbs notes-samling med den aktuella tidsstämpeln.

Svar

Name	Typ	Description
200 OK	object	Begäran har slutförts.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Ett oväntat felsvar. Sidhuvuden x-ms-error-code: string

Säkerhet

AadOauth2Auth

The Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: accessCode
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize
Token-webbadress: https://login.microsoftonline.com/common/oauth2/token

Omfattningar

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

Exempel

Cancels a job

Submits request to cancel an existing job

Cancels a job

Exempelbegäran

HTTP

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

{}

Exempelsvar

Statuskod:

200

{}

Submits request to cancel an existing job

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:

200

{}

Definitioner

Name	Description
Azure.Core.Foundations.Error	Felobjektet.
Azure.Core.Foundations.ErrorResponse	Ett svar som innehåller felinformation.
Azure.Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
CancelJobOptions	Begär nyttolast för att avbryta ett jobb.

Azure.Core.Foundations.Error

Felobjektet.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
details	Azure.Core.Foundations.Error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	Azure.Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

Azure.Core.Foundations.ErrorResponse

Ett svar som innehåller felinformation.

Name	Typ	Description
error	Azure.Core.Foundations.Error	Felobjektet.

Azure.Core.Foundations.InnerError

Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
innererror	Azure.Core.Foundations.InnerError	Inre fel.

CancelJobOptions

Begär nyttolast för att avbryta ett jobb.

Name	Typ	Description
dispositionCode	string	Anger resultatet av ett jobb och fyller i det här fältet med dina egna anpassade värden. Om det inte anges anges standardvärdet "Avbrytd".
note	string	En anteckning som läggs till i ett jobbs notes-samling med den aktuella tidsstämpeln.