Contrôle de version de l’abonnement aux événements

Dernière mise à jour : 22 avril 2025

Rubriques :

Créé pour :

Développeur

Workfront propose deux versions d’abonnements aux événements. Cet article décrit les différences entre eux.

La nouvelle version ne constitue pas une modification de l’API Workfront, mais plutôt une modification de la fonctionnalité d’abonnement aux événements.

La possibilité de mettre à niveau ou de rétrograder des abonnements aux événements garantit que lorsque des modifications sont apportées à la structure des événements, les abonnements existants ne sont pas rompus, ce qui vous permet de tester et de mettre à niveau vers la nouvelle version sans interruption de votre abonnement aux événements.

Lorsque vous mettez à niveau ou rétrogradez votre abonnement à un événement vers une autre version, vous recevez des événements en double pour chaque diffusion d’événement pendant une période de cinq minutes après le changement de version. Les doublons incluent chacun un abonnement à l'événement version 1 et version 2. Vous êtes ainsi assuré de ne manquer aucun événement lié à la modification de la version d’abonnement à l’événement.

Pour plus d’informations sur les points d’entrée utilisés pour mettre à niveau ou rétrograder des abonnements aux événements, consultez Contrôle de version des abonnements aux événements dans l’article API d’abonnement aux événements.

IMPORTANT

Les versions suivantes affecteront le contrôle de version des abonnements aux événements :

Version 25.2 (10 avril 2025) : tous les nouveaux abonnements créés après la version 25.2 sont créés en tant que version 2.
Version 25.3 (17 juillet 2025) : les abonnements ne peuvent plus être rétrogradés à la version 1 après la version 25.3.
1er septembre 2025 : tous les abonnements restants de la version 1 sont migrés vers la version 2.

Modifications entre les versions 1 et 2

Les modifications suivantes ont été apportées aux abonnements aux événements version 2 :

Modifications générales

Champs concernés Version 1 (comportement précédent) Version 2 (Modifier) Action corrective

Valeurs de paramètre calculées Tout objet créé à partir d’un modèle qui incluait un formulaire personnalisé avec des valeurs de paramètre calculées, un événement CREATE était envoyé, puis un UPDATE était envoyé avec les valeurs de paramètre (y compris les champs calculés et leurs valeurs). Lorsqu’un objet est créé à partir d’un modèle qui inclut un formulaire personnalisé avec des valeurs de paramètre calculées, seul un événement CREATE est envoyé et contient les valeurs de paramètre, y compris les champs calculés. Si vous disposez d’un abonnement pour UPDATE événements et que vous prévoyez de recevoir un événement UPDATE après la création d’un objet avec des valeurs de paramètre calculées, vous ne recevrez plus cet événement UPDATE. Si vous souhaitez afficher les valeurs de paramètre calculées lors de la création d’objet, vous devez créer un abonnement CREATE supplémentaire.

Champs de type Sélection multiple

Champs concernés	Version 1 (comportement précédent)	Version 2 (Modifier)	Action corrective
Valeurs de paramètre calculées	Tout objet créé à partir d’un modèle qui incluait un formulaire personnalisé avec des valeurs de paramètre calculées, un événement `CREATE` était envoyé, puis un `UPDATE` était envoyé avec les valeurs de paramètre (y compris les champs calculés et leurs valeurs).	Lorsqu’un objet est créé à partir d’un modèle qui inclut un formulaire personnalisé avec des valeurs de paramètre calculées, seul un événement `CREATE` est envoyé et contient les valeurs de paramètre, y compris les champs calculés.	Si vous disposez d’un abonnement pour `UPDATE` événements et que vous prévoyez de recevoir un événement `UPDATE` après la création d’un objet avec des valeurs de paramètre calculées, vous ne recevrez plus cet événement `UPDATE`. Si vous souhaitez afficher les valeurs de paramètre calculées lors de la création d’objet, vous devez créer un abonnement `CREATE` supplémentaire.
Champs de type Sélection multiple	Pour tout type d’événement contenant une modification sur un champ de type à sélection multiple, si le champ ne contenait qu’une seule valeur, il était converti en et envoyé sous la forme d’une chaîne. Sinon, elle serait envoyée sous la forme d’un tableau. Exemples : `myMultiSelectField: ["oneValue"]` est converti et envoyé en tant que `myMultiSelectField: "oneValue"`. `myMultiSelectField: ["first", "second"]` est envoyé en tant que `myMultiSelectField: ["first", "second"]`.	Quel que soit le nombre de valeurs dans le tableau, il sera envoyé en tant que tableau. Exemples : `myMultiSelectField: ["oneValue"]` est envoyé en tant que `myMultiSelectField: ["oneValue"]`. `myMultiSelectField: ["first", "second"]` est envoyé en tant que `myMultiSelectField: ["first", "second"]`.	Si vous disposez d’un abonnement avec un filtre sur un champ à sélection multiple et la valeur sous la forme d’une chaîne, vous devez créer un abonnement avec le même filtre qui possède la valeur sous la forme d’un tableau.

Pour tout type d’événement contenant une modification sur un champ de type à sélection multiple, si le champ ne contenait qu’une seule valeur, il était converti en et envoyé sous la forme d’une chaîne. Sinon, elle serait envoyée sous la forme d’un tableau.

Exemples :

myMultiSelectField: ["oneValue"] est converti et envoyé en tant que myMultiSelectField: "oneValue".
myMultiSelectField: ["first", "second"] est envoyé en tant que myMultiSelectField: ["first", "second"].

Quel que soit le nombre de valeurs dans le tableau, il sera envoyé en tant que tableau.

Exemples :

myMultiSelectField: ["oneValue"] est envoyé en tant que myMultiSelectField: ["oneValue"].
myMultiSelectField: ["first", "second"] est envoyé en tant que myMultiSelectField: ["first", "second"].

Si vous disposez d’un abonnement avec un filtre sur un champ à sélection multiple et la valeur sous la forme d’une chaîne, vous devez créer un abonnement avec le même filtre qui possède la valeur sous la forme d’un tableau.

Modifications spécifiques à l’objet

Code objet	Champs concernés	Version 1 (Comportement précédent)	Version 2 (Modifier)	Action corrective
ASSGN	`projectID` `taskID` `opTaskID` `customerID`	Lorsque cet objet a été mis à jour, l’événement `UPDATE` a parfois indiqué de manière incorrecte que les champs affectés passaient de `null` à `ID value`.	Tous les événements `UPDATE` affichent la valeur correcte pour les champs concernés.	Aucun. Si vous disposez d’un filtre sur les champs concernés, vous ne recevez un événement `UPDATE` que si ces champs ont réellement changé, et non si une autre valeur a été modifiée.
DOCU	`referenceObjID`	Lorsqu’une valeur de paramètre a été mise à jour sur cet objet, l’événement `UPDATE` a incorrectement affiché le changement de champ affecté de `null` à `object id`.	Tous les événements `UPDATE` affichent la valeur correcte pour les champs concernés.	Aucun. Si vous disposez d’un filtre sur les champs concernés, vous ne recevez un événement `UPDATE` que si ces champs ont réellement changé, et non si une autre valeur a été modifiée.
DOCU	`groups`	Lorsqu’un document a été supprimé, l’événement `DELETE` affichait incorrectement le champ affecté sous la forme d’un tableau vide à l’état « before ».	L’événement `DELETE` affiche correctement le champ affecté à l’état « before ».	Aucun. L’événement `DELETE` sera toujours envoyé, mais affichez désormais les données correctes pour le champ affecté.
DOCV	`proofDecision` `proofName` `proofProgress`	Lorsque cet objet a été mis à jour, deux événements `UPDATE` ont été envoyés. Le premier événement n’incluait pas les champs concernés, alors que le second l’a fait.	Toutes les mises à jour des champs, y compris les champs concernés, sont présentes dans un seul événement `UPDATE` et aucun second événement inutile n’est envoyé.	Aucun. Si les champs concernés appliquent un filtre, les événements sont diffusés dans le premier événement.
EXPNS	`topReferenceObjCode` `referenceObjectName`	Lorsqu'une valeur de paramètre a été mise à jour sur une dépense, l'événement `UPDATE` affichait incorrectement topReferenceObjCode modifié de `EXPNS` en `PROJ`, et `referenceObjectName` modifié de `null` en `string value of project name`.	Tous les événements `UPDATE` affichent la valeur correcte pour les champs concernés.	Aucun. Si vous disposez d’un filtre sur les champs concernés, vous ne recevez un événement `UPDATE` que si ces champs ont réellement changé, et non si une autre valeur a été modifiée.
EXPNS	`topReferenceObjCode` `referenceObjectName`	Lorsqu'un objet Expense a été supprimé, un événement de `UPDATE` a été envoyé, modifiant les champs concernés en les rendant nuls avant l'envoi de l'événement de `DELETE`.	L’événement `UPDATE` supplémentaire n’est pas envoyé. L’événement `DELETE` contient des valeurs correctes pour les champs concernés à l’état « avant ».	Si vous disposez d’un filtre pour les champs concernés par les événements `UPDATE` et que vous prévoyez de le recevoir lorsque l’objet est supprimé, vous ne recevez plus cet événement `UPDATE`. Si vous souhaitez afficher ces champs lors de la suppression de l’objet , vous devez créer un abonnement `DELETE` supplémentaire.
HOUR	`projectID` `taskID` `roleID` `timesheetID` `hourTypeID` `projectOverheadID` `referenceObjID` `referenceObjCode` `securityRootID`	Lorsque cet objet a été supprimé, l’événement `DELETE` affichait incorrectement les champs affectés tels qu’`null` dans l’état « before ».	L’événement `DELETE` affiche correctement les champs concernés à l’état « before ».	Aucun. L’événement `DELETE` est toujours envoyé, mais affiche désormais les données correctes pour les champs concernés.
OPTASK	`rootGroupID`	Lorsqu’une valeur de paramètre a été mise à jour sur cet objet, l’événement `UPDATE` a incorrectement affiché le changement de champ affecté de `null` à `ID value`.	Tous les événements `UPDATE` affichent la valeur correcte pour le champ concerné.	Aucun. Si vous disposez d’un filtre sur le champ affecté, vous ne recevez un événement `UPDATE` que si ce champ a réellement changé, et non si une autre valeur de paramètre a changé.
OPTASK	`resolveProjectID` `resolveTaskID` `resolvingObjID`	Lorsque cet objet a été mis à jour, l’événement `UPDATE` a parfois indiqué de manière incorrecte que les champs affectés passaient de `null` à `ID value`.	Tous les événements `UPDATE` affichent la valeur correcte pour les champs concernés.
PROJ	`rootGroupID`	Lorsqu’une valeur de paramètre a été mise à jour sur cet objet, l’événement `UPDATE` a incorrectement affiché le changement de champ affecté de `null` à `ID value`.	Tous les événements `UPDATE` affichent la valeur correcte pour le champ concerné.	Aucun. Si vous disposez d’un filtre sur le champ affecté, vous ne recevez un événement `UPDATE` que si ce champ a réellement changé, et non si une autre valeur de paramètre a changé.
PROJ	`convertedOpTaskID`	Lorsque cet objet a été mis à jour, l’événement `UPDATE` a parfois indiqué de manière incorrecte que les champs affectés passaient de `null` à `ID value`.	Tous les événements `UPDATE` affichent la valeur correcte pour le champ concerné.	Aucun. Si vous disposez d’un filtre sur le champ affecté, vous ne recevez un événement `UPDATE` que si ce champ a réellement changé, et non si une autre valeur de paramètre a changé.
TASK	`rootGroupID`	Lorsqu’une valeur de paramètre a été mise à jour sur cet objet, l’événement `UPDATE` a incorrectement affiché le changement de champ affecté de `null` à `ID value`.	Tous les événements `UPDATE` affichent la valeur correcte pour le champ concerné.	Aucun. Si vous disposez d’un filtre sur le champ affecté, vous ne recevez un événement `UPDATE` que si ce champ a réellement changé, et non si une autre valeur de paramètre a changé.
TASK	`convertedOpTaskID`	Lorsque cet objet a été mis à jour, l’événement `UPDATE` a parfois indiqué de manière incorrecte que les champs affectés passaient de `null` à `ID value`.	Tous les événements `UPDATE` affichent la valeur correcte pour le champ concerné.	Aucun. Si vous disposez d’un filtre sur le champ affecté, vous ne recevez un événement `UPDATE` que si ce champ a réellement changé, et non si une autre valeur de paramètre a changé.

Mise à jour de la version d’abonnement aux événements dans un scénario Workfront Fusion

Workfront Fusion utilise les abonnements aux événements pour surveiller les modifications dans Workfront afin de déclencher des scénarios. Vous pouvez mettre à jour la version d’abonnement aux événements que Fusion utilise directement dans un scénario, à l’aide du module Workfront > Mettre à jour la version de la payload des événements .

Pour obtenir des instructions sur l’utilisation de ce module, voir Modules Workfront dans la documentation de Workfront Fusion.

recommendation-more-help