Job Router Operations - Unassign Job

Service:

Communication

Version d'API:

2023-11-01

Annuler l’affectation d’un travail.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
assignmentId	path	True	string	ID d’une attribution de travail.
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
suspendMatching	boolean	Si SuspendMatching a la valeur true, un travail n’est pas mis en file d’attente pour une nouvelle correspondance avec un worker.

Réponses

Nom	Type	Description
200 OK	UnassignJobResult	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

Un-assign a job

Exemple de requête

HTTP

POST https://contoso.westus.communications.azure.com/routing/jobs/8780b28c-7079-4de1-9143-4d369289e958/assignments/1d5896f3-8b54-40be-82d3-910323f5e2af:unassign?api-version=2023-11-01

{
  "suspendMatching": false
}

Exemple de réponse

Code d’état:

200

{
  "jobId": "8780b28c-7079-4de1-9143-4d369289e958",
  "unassignmentCount": 1
}

Définitions

Nom	Description
Azure.Core.Foundations.Error	Objet error.
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 de l’API Microsoft One : https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
UnassignJobOptions	Charge utile de demande pour annuler l’affectation d’un travail.
UnassignJobResult	Charge utile de réponse une fois qu’un travail a été correctement désaffecté.

Azure.Core.Foundations.Error

Objet error.

Nom	Type	Description
code	string	Un des ensembles de 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 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 error.

Azure.Core.Foundations.InnerError

Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions de 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 ensembles de codes d’erreur définis par le serveur.
innererror	Azure.Core.Foundations.InnerError	Erreur interne.

UnassignJobOptions

Charge utile de demande pour annuler l’affectation d’un travail.

Nom	Type	Description
suspendMatching	boolean	Si SuspendMatching a la valeur true, un travail n’est pas mis en file d’attente pour une nouvelle correspondance avec un worker.

UnassignJobResult

Charge utile de réponse une fois qu’un travail a été correctement désaffecté.

Nom	Type	Description
jobId	string	ID d’un travail non attribué.
unassignmentCount	integer	Nombre de fois qu’un travail n’est pas attribué. Au maximum 3.