Job Router Operations - Close Job

Service:

Communication

Version d'API:

2023-11-01

Ferme un travail terminé.

POST {endpoint}/routing/jobs/{jobId}/assignments/{assignmentId}:close?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
closeAt	string	Si elle n’est pas fournie, la capacité de travail est immédiatement libérée avec une notification JobClosedEvent. Si elle est fournie, la capacité de travail est libérée avec une notification JobClosedEvent à une heure ultérieure en UTC.
dispositionCode	string	Indique le résultat d’un travail, renseignez ce champ avec vos propres valeurs personnalisées.
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

Closes a completed 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:close?api-version=2023-11-01

{
  "dispositionCode": "JobCompleted.",
  "note": "Closing job"
}

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.
CloseJobOptions	Charge utile de requête pour la fermeture des travaux

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.

CloseJobOptions

Charge utile de requête pour la fermeture des travaux

Nom	Type	Description
closeAt	string	Si elle n’est pas fournie, la capacité de travail est immédiatement libérée avec une notification JobClosedEvent. Si elle est fournie, la capacité de travail est libérée avec une notification JobClosedEvent à une heure ultérieure en UTC.
dispositionCode	string	Indique le résultat d’un travail, renseignez ce champ avec vos propres valeurs personnalisées.
note	string	Note qui sera ajoutée à la collection Notes d’un travail avec l’horodatage actuel.