Job Router Operations - Cancel Job

Service:

Communication

Version d'API:

2023-11-01

Envoie une demande d’annulation d’un travail existant par ID tout en fournissant le motif d’annulation de formulaire libre.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string	URI de votre ressource communication
jobId	path	True	string	ID d’un travail.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Type	Description
dispositionCode	string	Indique le résultat d’un travail, renseignez ce champ avec vos propres valeurs personnalisées. S’il n’est pas fourni, la valeur par défaut « Cancelled » est définie.
note	string	Note qui sera ajoutée à la collection Notes d’un travail avec l’horodatage actuel.

Réponses

Nom	Type	Description
200 OK	object	La demande a réussi.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Réponse d’erreur inattendue. En-têtes x-ms-error-code: string

Exemples

Cancels a job

Submits request to cancel an existing job

Cancels a job

Exemple de requête

HTTP

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

{}

Exemple de réponse

Code d’état:

200

{}

Submits request to cancel an existing job

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:

200

{}

Définitions

Nom	Description
Azure.Core.Foundations.Error	Objet d’erreur.
Azure.Core.Foundations.ErrorResponse	Réponse contenant les détails de l’erreur.
Azure.Core.Foundations.InnerError	Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions relatives à l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
CancelJobOptions	Charge utile de demande pour l’annulation d’un travail.

Azure.Core.Foundations.Error

Objet d’erreur.

Nom	Type	Description
code	string	Un des codes d’erreur définis par le serveur.
details	Azure.Core.Foundations.Error[]	Tableau de détails sur les erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror	Azure.Core.Foundations.InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible par l’homme de l’erreur.
target	string	Cible de l’erreur.

Azure.Core.Foundations.ErrorResponse

Réponse contenant les détails de l’erreur.

Nom	Type	Description
error	Azure.Core.Foundations.Error	Objet d’erreur.

Azure.Core.Foundations.InnerError

Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions relatives à l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nom	Type	Description
code	string	Un des codes d’erreur définis par le serveur.
innererror	Azure.Core.Foundations.InnerError	Erreur interne.

CancelJobOptions

Charge utile de demande pour l’annulation d’un travail.

Nom	Type	Description
dispositionCode	string	Indique le résultat d’un travail, renseignez ce champ avec vos propres valeurs personnalisées. S’il n’est pas fourni, la valeur par défaut « Cancelled » est définie.
note	string	Note qui sera ajoutée à la collection Notes d’un travail avec l’horodatage actuel.