Nouveautés de la version 12 de l’API
Créé pour :
- Développeur
Workfront a publié la version 12 de l’API le 12 novembre 2020. La version 12 de l’API présente les changements suivants par rapport à la version 11.
Ressources ajoutées
Les ressources suivantes sont nouvelles dans la version 12 de l’API Workfront.
BreadCrumb
Un objet BreadCrumb représente un élément dans la hiérarchie parent/enfant d’un élément de travail Adobe Workfront. Les chemins de navigation indiquent comment un élément de travail s’intègre à la structure plus vaste des portfolios, projets, problèmes et tâches.
Pour plus d’informations sur les chemins de navigation dans Workfront, voir Vue d’ensemble des chemins de navigation dans la nouvelle expérience Adobe Workfront
- getObjectHierarchy
RichTextParameterValue
Les champs de texte enrichi sont désormais disponibles sur un plus grand nombre d’objets. L’objet RichTextParameterValue a été ajouté à Workfront pour prendre en charge cette disponibilité.
Pour plus d’informations, voir Champs de texte enrichi dans l’API Adobe Workfront.
- ID
- ID
- objCode
Ressources supprimées
Aucune ressource n’a été supprimée pour la version 12 de l’API.
Ressources modifiées
Les ressources suivantes ont été modifiées pour la version 12 de l’API Workfront.
AccessLevel
Un objet AccessLevel est associé à des personnes et décrit le jeu d’autorisations AccessLevelPermissions qui déterminent ce à quoi la personne peut accéder.
Pour plus d’informations sur les niveaux d’accès, voir Fonctionnement des niveaux d’accès.
AccessLevelPermissions
Un objet AccessLevelPermissions représente une autorisation spécifique d’accès, de création ou de modification d’un objet Workfront. Ces autorisations peuvent ensuite être associées à un niveau d’accès.
-
coreAction
Les possibleValues suivantes ont été ajoutées :
-
PLANNED_HOURS_CONTOURING
Une personne disposant d’un niveau d’accès incluant cette autorisation peut mettre à jour le nombre d’heures prévues dans l’équilibreur de charge de travail.
Pour plus d’informations, voir Mettre à jour le nombre d’heures prévues d’une tâche lors de la gestion des affectations des personnes dans Gérer les affectations des personnes dans l’équilibreur de charge de travail.
-
ADD_TO_CUSTOM_FORMS
Une personne dont le niveau d’accès comprend cette autorisation peut ajouter des champs aux formulaires personnalisés.
Pour plus d’informations, voir Créer ou modifier un formulaire personnalisé.
-
EDIT_SYSTEMWIDE
Une personne disposant d’un niveau d’accès incluant cette autorisation peut partager un champ personnalisé dans l’ensemble du système avec l’accès Supprimer.
-
-
forbiddenActions
Les possibleValues suivantes ont été ajoutées :
-
PLANNED_HOURS_CONTOURING
-
ADD_TO_CUSTOM_FORMS
-
EDIT_SYSTEMWIDE
-
-
secondaryActions
Les possibleValues suivantes ont été ajoutées :
-
PLANNED_HOURS_CONTOURING
-
ADD_TO_CUSTOM_FORMS
-
EDIT_SYSTEMWIDE
-
AccessRequest
Si une personne n’a pas accès à un objet Workfront dont elle a besoin, elle peut demander l’accès à cet objet. L’objet AccessRequest représente cette requête.
-
action
Les possibleValues suivantes ont été ajoutées :
-
PLANNED_HOURS_CONTOURING
Une personne disposant d’un niveau d’accès incluant cette autorisation peut mettre à jour le nombre d’heures prévues dans l’équilibreur de charge de travail.
Pour plus d’informations, voir Mettre à jour le nombre d’heures prévues d’une tâche lors de la gestion des affectations des personnes dans Gérer les affectations des personnes dans l’équilibreur de charge de travail.
-
ADD_TO_CUSTOM_FORMS
Une personne dont le niveau d’accès comprend cette autorisation peut ajouter des champs aux formulaires personnalisés.
Pour plus d’informations, voir Créer ou modifier un formulaire personnalisé.
-
EDIT_SYSTEMWIDE
Une personne disposant d’un niveau d’accès incluant cette autorisation peut partager un champ personnalisé dans l’ensemble du système avec l’accès Supprimer.
-
AccessRule
Un objet AccessRule représente un jeu de règles dans les niveaux d’accès personnalisés qui détermine comment les personnes peuvent partager les projets qu’elles créent.
-
coreAction
Les possibleValues suivantes ont été ajoutées :
-
PLANNED_HOURS_CONTOURING
Une personne disposant d’un niveau d’accès incluant cette autorisation peut mettre à jour le nombre d’heures prévues dans l’équilibreur de charge de travail.
Pour plus d’informations, voir Mettre à jour le nombre d’heures prévues d’une tâche lors de la gestion des affectations des personnes dans Gérer les affectations des personnes dans l’équilibreur de charge de travail.
-
ADD_TO_CUSTOM_FORMS
Une personne dont le niveau d’accès comprend cette autorisation peut ajouter des champs aux formulaires personnalisés.
Pour plus d’informations, voir Créer ou modifier un formulaire personnalisé.
-
EDIT_SYSTEMWIDE
Une personne disposant d’un niveau d’accès incluant cette autorisation peut partager un champ personnalisé dans l’ensemble du système avec l’accès Supprimer.
-
-
forbiddenActions
Les possibleValues suivantes ont été ajoutées :
-
PLANNED_HOURS_CONTOURING
-
ADD_TO_CUSTOM_FORMS
-
EDIT_SYSTEMWIDE
-
-
secondaryActions
Les possibleValues suivantes ont été ajoutées :
-
PLANNED_HOURS_CONTOURING
-
ADD_TO_CUSTOM_FORMS
-
EDIT_SYSTEMWIDE
-
ActivityLog
Un objet ActivityLog est une liste complète de toutes les activités qui ont eu lieu dans un compte Workfront Proof donné.
L’opération suivante a été supprimée de l’objet ActivityLog :
- ADD
AnnouncementAttachment
Un objet AnnouncementAttachment représente un fichier qui a été joint à une annonce Workfront.
Pour en savoir plus sur les pièces jointes aux annonces, voir Envoyer des annonces.
-
fileExtension
Ajout des valeurs possibles :
-
qdoc (enum.fileextension.qdoc)
-
qslides (enum.fileextension.qslides)
-
qsheet (enum.fileextension.qsheet)
-
Approbation
Un élément de travail donné, tel qu’une tâche, un document ou une feuille de temps, peut exiger qu’une personne en charge de la supervision ou une autre personne valide l’élément de travail. Un objet Approbation représente l’action de validation d’un élément de travail.
-
backlogOrder
Suppression des indicateurs suivants :
-
DYNAMIC,
-
LAZY_READ,
-
NOT_GROUPABLE
-
-
groupID
Les indicateurs suivants ont été ajoutés.
-
AUTO_LOAD,
-
DYNAMIC,
-
READ_ONLY
-
-
workEffort
Ce champ a été ajouté et indique si la réalisation d’une tâche demande à la personne un effort quotidien petit, moyen ou grand. Les valeurs possibles sont les suivantes :
-
1 (petit)
-
2 (moyen)
-
3 (grand)
Pour plus d’informations sur l’effort de travail dans Workfront, voir Vue d’ensemble de l’effort de travail.
-
CalendarSection
Une section de calendrier est un rapport de calendrier.
Pour plus d’informations sur les rapports de calendrier, voir Vue d’ensemble des rapports de calendrier.
Les champs suivants ont été ajoutés à l’objet CalendarSection pour prendre en charge la nouvelle fonctionnalité d’utilisation de dates personnalisées dans les rapports de calendrier.
Pour plus d’informations, voir Utiliser des champs de date personnalisés dans un rapport de calendrier.
-
customDate
-
customEndDateParameterID
-
customStartDateParameterID
-
ignoreActualDates
Entreprise
Un objet Company représente une organisation composée d’un ensemble de personnes.
Pour plus d’informations sur les entreprises, voir Créer et modifier des entreprises.
-
groupID
ID du groupe auquel l’entreprise est associée.
-
groupe
Groupe auquel l’entreprise est associée. L’association d’une entreprise à un groupe permet à l’administrateur ou administratrice de groupes d’étendre l’accès et les autorisations du groupe à l’entreprise.
Client
Un objet Customer représente une organisation qui utilise une instance de Workfront.
-
productEnabled
Cette action prend un argument CustomerProductTypeEnum et renvoie un booléen qui indique si le client ou la cliente a un compte pour ce produit.
CustomerPreferences
Un objet CustomerPreferences représente l’ensemble des préférences définies par un client ou une cliente pour son instance de Workfront.
-
name
Ajout des valeurs possibles :
- password:zoomInegrationEnabled (Activer l’intégration Zoom dans le flux de mises à jour)
- password:quipIntegrationEnabled (config.general.quip.enabled)
Document
Un objet Document représente un fichier (tel que du matériel écrit, des images ou d’autres formes d’informations).
-
createLinkedProofVersion
Ajouté(e)(s)
DocumentVersion
Un objet DocumentVersion représente une version spécifique d’un fichier (comme du contenu écrit, des images ou d’autres formes d’informations).
Pour plus d’informations sur les versions des documents, voir Charger une nouvelle version d’un document.
-
externalIntegrationType
Valeur possible supprimée :
- QUIP (Quip)
-
proofDecision
Ajouté(e)(s)
Les actions suivantes ont été ajoutées à l’objet Document :
-
getDocumentReviewerDecision
Cette action prend l’argument documentVersonID (chaîne) et renvoie une carte indiquant la décision du réviseur ou de la réviseuse.
-
setDocumentReviewerDecision
Cette action prend les arguments suivants :
-
documentVersionID (string)
-
reviewerDecision (string)
-
comment (string)
-
Groupe
Un objet Group représente un ensemble d’utilisateurs et utilisatrices et d’équipes. Les groupes représentent souvent la structure des services.
-
businessLeaderID
ID de la personne à la tête de l’entreprise affectée au groupe.
-
businessLeader
Personne à la tête de l’entreprise affectée au groupe. La ou le responsable commercial est la personne qui prend des décisions commerciales pour le groupe.
Pour plus d’informations sur les personnes à la tête d’une entreprise, voir la section Vue d’ensemble des personnes à la tête d’une entreprise.
-
assignMultiple
Cette action prend les arguments suivants :
-
userIDs (string[])
-
roleIDs (string[])
-
teamID (string)
-
-
getGroupMembers
-
updateMembersList
Cette action prend les arguments suivants :
-
newMemberIDs (string[])
-
removedMemberDs (string[])
-
LinkedFolder
Un objet LinkedFolder représente un dossier lié à un fournisseur de documents externe, tel que Google Drive ou Dropbox.
Pour plus d’informations sur les dossiers liés, voir Lier des documents à partir d’applications externes.
-
externalIntegrationType
Valeur possible supprimée :
- QUIP (Quip)
TâcheOp
Un objet OpTask est généralement appelé Problème. Un problème est un élément de travail qui indique généralement qu’un problème empêche la réalisation d’une tâche ou d’un projet. Il peut également s’agir d’une demande de centre d’assistance. Les ordres de modification, les requêtes et les bugs sont également des problèmes.
-
backlogOrder
L’ordre indique la position d’une tâche ou d’une histoire dans la liste d’attente Agile.
Ce champ a supprimé les indicateurs suivants :
- DYNAMIC,
- LAZY_READ,
- NOT_GROUPABLE :
Ces actions ont ajouté l’argument status pour prendre en charge la nouvelle fonctionnalité du bouton Démarrer, qui modifie le statut d’un élément de travail lorsqu’une personne clique sur le bouton pour indiquer qu’elle a commencé à travailler sur l’élément.
Pour plus d’informations, voir Remplacer le bouton Travailler sur ce projet par un bouton Démarrer.
-
acceptWork
-
unacceptWork
Paramètre
Un objet de paramètre est un champ personnalisé.
La ressource Paramètre a ajouté l’indicateur SHARABLE.
Pour plus d’informations sur les champs personnalisés, voir Créer ou modifier un formulaire personnalisé dans Créer ou modifier un formulaire personnalisé.
-
dataType
Ajout de la valeur possible :
-
RICH (texte enrichi)
Pour plus d’informations, voir Champs de texte enrichi dans l’API Adobe Workfront.
-
-
displayType
Ajout de la valeur possible :
-
RICH (champ de texte avec formatage)
Pour plus d’informations, voir Champs de texte enrichi dans l’API Adobe Workfront.
-
-
label
Ajouté(e)(s)
-
accessRules
Ajouté(e)(s)
-
label
Ajouté(e)(s)
Portfolio
Un objet Portfolio est un ensemble de projets qui rivalisent pour les mêmes ressources, généralement de l’argent ou des personnes pour les mener à bien.
Pour plus d’informations sur les portfolios, voir Vue d’ensemble des portfolios dans Adobe Workfront.
-
groupID
ID du groupe auquel le portfolio est associé.
-
groupe
Groupe auquel le portfolio est associé.
Programme
Un objet de programme est un sous-ensemble de projets d’un portfolio, où des projets similaires peuvent être regroupés.
-
groupID
ID du groupe auquel le programme est associé.
-
groupe
Groupe auquel le programme est associé.
QueueDef
Un objet QueueDef représente une file d’attente, qui est un projet qui a été publié dans la zone Centre d’assistance pour permettre aux utilisateurs et utilisatrices de lui soumettre des problèmes.
Pour plus d’informations sur les files d’attente des demandes, voir Créer une file d’attente des demandes.
-
requestorCoreAction
Les possibleValues suivantes ont été ajoutées :
-
PLANNED_HOURS_CONTOURING
Une personne disposant d’un niveau d’accès incluant cette autorisation peut mettre à jour le nombre d’heures prévues dans l’équilibreur de charge de travail.
Pour plus d’informations, voir Mettre à jour le nombre d’heures prévues d’une tâche lors de la gestion des affectations des personnes dans Gérer les affectations des personnes dans l’équilibreur de charge de travail.
-
ADD_TO_CUSTOM_FORMS
Une personne dont le niveau d’accès comprend cette autorisation peut ajouter des champs aux formulaires personnalisés.
Pour plus d’informations, voir Créer ou modifier un formulaire personnalisé.
-
EDIT_SYSTEMWIDE
Une personne disposant d’un niveau d’accès incluant cette autorisation peut partager un champ personnalisé dans l’ensemble du système avec l’accès Supprimer.
-
PLANNED_HOURS_CONTOURING
-
ADD_TO_CUSTOM_FORMS
-
EDIT_SYSTEMWIDE
-
-
ScheduledReport
Un objet ScheduledReport représente un rapport qui a été configuré pour être diffusé.
-
format
Ajout des valeurs possibles :
-
qdoc (enum.fileextension.qdoc)
-
qslides (enum.fileextension.qslides)
-
qsheet (enum.fileextension.qsheet)
-
ScoreCardQuestion
Un objet ScoreCardQuestion représente une question qui a été ajoutée à une carte de performance. Ces questions sont généralement définies par la personne gestionnaire du portfolio et leurs réponses lui permettent de comprendre dans quelle mesure un projet s’aligne sur les objectifs du portfolio.
Pour plus d’informations sur les questions relatives aux cartes de performance, voir Créer une carte de performance.
-
displayType
Ajout de la valeur possible RICH (champ de texte avec formatage)
Pour plus d’informations, voir Champs de texte enrichi dans l’API Adobe Workfront.
Tâche
Un objet Task représente un élément de travail qui doit être exécuté comme une étape vers la réalisation d’un objectif final (achèvement d’un projet).
-
workEffort
Ce champ a été ajouté et indique si la réalisation d’une tâche demande à la personne un effort quotidien petit, moyen ou grand. Les valeurs possibles sont les suivantes :
-
1 (petit)
-
2 (moyen)
-
3 (grand)
Pour plus d’informations sur l’effort de travail dans Workfront, voir Vue d’ensemble de l’effort de travail.
-
Ces actions ont ajouté l’argument status pour prendre en charge la nouvelle fonctionnalité du bouton Démarrer, qui modifie le statut d’un élément de travail lorsqu’une personne clique sur le bouton pour indiquer qu’elle a commencé à travailler sur l’élément.
Pour plus d’informations, voir Remplacer le bouton Travailler sur ce projet par un bouton Démarrer.
-
acceptWork
-
unacceptWork
Equipe
Un objet Team est un ensemble d’utilisateurs et d’utilisatrices pouvant être affectés à un élément de travail.
Les champs suivants ont été ajoutés à la ressource Équipe :
-
groupID
Ce champ associe une équipe à un groupe. Cela permet d’identifier l’équipe comme faisant partie du groupe et permet à l’équipe d’administration du groupe de gérer les équipes.
-
workOnItStatusChange
Il s’agit d’un paramètre booléen qui indique si le bouton Travailler sur cette tâche de l’équipe a été configuré à la manière d’un bouton Démarrer. Lorsqu’une personne membre de l’équipe clique sur le bouton Démarrer pour commencer à travailler sur un élément de travail, le statut de l’élément passe de Nouveau à un statut configuré dans les paramètres de l’équipe.
-
Les champs suivants permettent de spécifier des statuts personnalisés pour le bouton Démarrer sur les éléments de travail individuels.
-
workOnItOpTaskBugReportStatuses
-
workOnItOpTaskChangeOrderStatuses
-
workOnItOpTaskIssueStatuses
-
workOnItOpTaskRequestStatuses
workOnItTaskStatuses
Pour plus d’informations sur le bouton Démarrer, voir la section Remplacer le bouton Travailler sur cette tâche par un bouton Démarrer.
-
Le champ suivant a été ajouté à la ressource Équipe :
- group
TemplateTask
Un objet TemplateTask représente une tâche qui fait partie d’un modèle. Les tâches de modèle deviennent des tâches dans le projet où le modèle est utilisé.
Pour plus d’informations sur les tâches modèles, voir la section Modifier une tâche de modèle.
-
workEffort
Ce champ a été ajouté et indique si la réalisation d’une tâche demande à la personne un effort quotidien petit, moyen ou grand. Les valeurs possibles sont les suivantes :
-
1 (petit)
-
2 (moyen)
-
3 (grand)
Pour plus d’informations sur l’effort de travail dans Workfront, voir la section Vue d’ensemble de l’effort de travail.
-
Feuille de temps
Un objet Timesheet représente une feuille de temps virtuelle qui permet aux utilisateurs et utilisatrices de saisir les heures effectives travaillées pour les tâches, les projets et les types d’heures supplémentaires.
Pour plus d’informations sur les feuilles de temps, voir la section Vue d’ensemble des feuilles de temps.
Le champ suivant a été supprimé de la ressource Feuille de temps :
- objcode
Mettre à jour
-
updateType
Ajout des valeurs possibles suivantes :
-
initiativeAdd (enum.updatetypeenum.initiativeadd)
-
initiativeEdit (enum.updatetypeenum.initiativeedit)
Pour plus d’informations sur les initiatives, voir la section Vue d’ensemble des initiatives dans le planificateur de scénarios.
-
l’utilisateur ou de l’utilisatrice
Un objet User représente une personne disposant d’un compte dans Workfront qui peut se connecter et interagir avec le système.
Les champs suivants ont été ajoutés à la ressource Utilisateur ou utilisatrice :
-
actualDeactivationDate
Il s’agit de la date et de l’heure auxquelles la personne a été désactivée.
Pour plus d’informations sur les personnes désactivées, voir Désactiver ou réactiver une personne.
-
alignAccessType
Ce champ indique l’accès de la personne aux Objectifs Workfront. Les valeurs possibles sont les suivantes :
-
Pas d’accès
-
Afficher
-
Modifier
-
L’action suivante a été ajoutée à la ressource Utilisateur ou utilisatrice :
-
getUserAccessPermissionsByObjCode
Cette action prend en compte les arguments suivants :
-
ids (string)
-
objCode (string)
-
Travail
Un objet Work est une interface commune dont Task et OpTask héritent tous deux et qui partage le code commun entre les deux.
-
backlogOrder
L’ordre indique la position d’une tâche ou d’une histoire dans la liste d’attente Agile.
Ce champ a supprimé les indicateurs suivants :
-
DYNAMIC,
-
LAZY_READ,
-
NOT_GROUPABLE
-
-
groupID
Ce champ a ajouté les indicateurs suivants :
-
AUTO_LOAD,
-
DYNAMIC,
-
READ_ONLY
-
-
workEffort
Ce champ a été ajouté et indique si la réalisation d’une tâche demande à la personne un effort quotidien petit, moyen ou grand. Les valeurs possibles sont les suivantes :
-
1 (petit)
-
2 (moyen)
-
3 (grand)
Pour plus d’informations sur l’effort de travail dans Workfront, voir Vue d’ensemble de l’effort de travail.
-