Job Router Operations - Cancel Job

Service:

Communication

API-versie:

2023-11-01

Hiermee wordt een aanvraag ingediend om een bestaande taak te annuleren op basis van de id terwijl u een annuleringsreden in het vrije formulier opgeeft.

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string	URI van uw communicatieresource
jobId	path	True	string	Id van een taak.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Type	Description
dispositionCode	string	Geeft het resultaat van een taak aan, vul dit veld in met uw eigen aangepaste waarden. Als dit niet is opgegeven, wordt de standaardwaarde 'Geannuleerd' ingesteld.
note	string	Een notitie die wordt toegevoegd aan de notitiesverzameling van een taak met de huidige tijdstempel.

Antwoorden

Name	Type	Description
200 OK	object	De aanvraag is voltooid.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Een onverwachte foutreactie. Kopteksten x-ms-error-code: string

Beveiliging

AadOauth2Auth

De Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: accessCode
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiken

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

Voorbeelden

Cancels a job

Submits request to cancel an existing job

Cancels a job

Voorbeeldaanvraag

HTTP

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

{}

Voorbeeldrespons

Statuscode:

200

{}

Submits request to cancel an existing job

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

200

{}

Definities

Name	Description
Azure.Core.Foundations.Error	Het foutobject.
Azure.Core.Foundations.ErrorResponse	Een antwoord met foutdetails.
Azure.Core.Foundations.InnerError	Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
CancelJobOptions	Nettolading aanvragen voor het annuleren van een taak.

Azure.Core.Foundations.Error

Object

Het foutobject.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	Azure.Core.Foundations.Error[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innererror	Azure.Core.Foundations.InnerError	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

Azure.Core.Foundations.ErrorResponse

Object

Een antwoord met foutdetails.

Name	Type	Description
error	Azure.Core.Foundations.Error	Het foutobject.

Azure.Core.Foundations.InnerError

Object

Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
innererror	Azure.Core.Foundations.InnerError	Interne fout.

CancelJobOptions

Object

Nettolading aanvragen voor het annuleren van een taak.

Name	Type	Description
dispositionCode	string	Geeft het resultaat van een taak aan, vul dit veld in met uw eigen aangepaste waarden. Als dit niet is opgegeven, wordt de standaardwaarde 'Geannuleerd' ingesteld.
note	string	Een notitie die wordt toegevoegd aan de notitiesverzameling van een taak met de huidige tijdstempel.