DocumentationWorkfrontGuide Workfront

Déplacer des objets entre des environnements Workfront à l’aide de l’API Promotion environnementale Workfront

Last update: Wed Jul 17 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Rubriques :

Créé pour :

  • Administration

La fonctionnalité Promotion de l’environnement vous permet de déplacer des objets liés à la configuration d’un environnement à un autre. Vous pouvez déplacer ces objets à l’aide de l’API Workfront, comme décrit dans cet article.

Pour obtenir des instructions sur le déplacement d’objets entre des environnements à l’aide de l’application Workfront, voir :

Conditions d’accès

Vous devez disposer des éléments suivants :

Plan Adobe Workfront
Prime ou Ultimate (Nouveaux plans uniquement)
Licences Adobe Workfront
Standard
Configurations du niveau d’accès
Vous devez être un administrateur ou une administratrice Workfront.

Pour plus d’informations sur ce tableau, consultez Conditions d’accès requises dans la documentation Workfront.

Conditions préalables

Le point d’entrée Créer un package de promotion part du principe que vous avez déjà configuré l’environnement source. Cet appel API nécessite la création manuelle d’un mappage d’objets objCodes Workfront et de GUID d’objets. La structure spécifique de ce mappage est décrite ci-dessous.

Objets pris en charge pour la promotion environnementale

La fonctionnalité Promotion environnementale vise à permettre de déplacer des objets liés à la configuration d’un environnement à un autre. Elle n’offre pas la possibilité de déplacer des objets transactionnels (à quelques exceptions près).

Pour obtenir la liste des objets pouvant être promus et de leurs sous-objets pouvant être promus inclus, voir Objets pris en charge pour la promotion environnementale dans l’article Vue d’ensemble du déplacement d’objets entre des environnements Workfront.

Authentification

L’API authentifie chaque demande pour s’assurer que la cliente ou le client dispose d’un accès pour afficher ou modifier un objet demandé.

L’authentification est effectuée en transmettant un ID de session ou une clé d’API, qui peut être fournie à l’aide de la méthode suivante :

Authentification de l’en-tête de la demande

La méthode d’authentification préférée consiste à transmettre un en-tête de demande nommé SessionID contenant le jeton de session. Il constitue une protection contre les attaques Cross-site Request Forgery (CSRF) et n’interfère pas avec l’URI à des fins de mise en cache.

Voici un exemple d’en-tête de demande :

GET /attask/api/v15.0/project/search
SessionID: abc1234

Points d’entrées d’API

Créer un package

POST /packages

Cet appel exécute un processus à plusieurs étapes.

La première étape entraîne la création d’un package de promotion vide au statut « ASSEMBLAGE ».

La deuxième étape utilise le tableau objectCollections fourni dans le corps POST pour assembler les enregistrements demandés à partir de Workfront. Cette étape peut prendre plusieurs minutes en fonction du nombre d’enregistrements demandés et de votre configuration Workfront. À la fin de ce processus, le package de promotion vide est mis à jour avec les packageEntities et le statut est automatiquement défini sur « BROUILLON ».

NOTE
Observez la structure du tableau objectCollections.
Chaque élément du tableau contient une clé objCode qui correspond au code d’objet documenté dans l’explorateur d’API Workfront.
Chaque élément contient également une collection d’entities. Le champ ID est ainsi attendu. Il peut également accepter un attribut name facultatif pour permettre de savoir plus facilement ce que représente ID.
Pour obtenir la liste des codes d’objet pouvant être demandés dans la liste objectCollections, voir la section Objets pris en charge pour la promotion environnementale dans cet article.

URL

POST https://{domain}.{environment}.workfront.com/environment-promotion/api/v1/packages

En-têtes

{
    "apikey": "**********",
    "Content-Type": "application/json"
}

Ou

{
    "sessionID": "*****************",
    "Content-Type": "application/json"
}

Corps

{
    "name": "Agency Onboarding - 2023-06-06",
    "description": "This promotion package contains configuration to support the agency onboarding processes...",
    "source": "https://{domain}.{environment}.workfront.com",
    "objectCollections": [
        {
            "objCode": "PROJ",
            "entities": [
                {
                    "ID": "6419b8b9001151ee258921a4f7597ba1",
                    "name": "Agency Request"
                }
            ]
        },
        {
            "objCode": "TMPL",
            "entities": [
                {
                    "ID": "6419b8b9001151ee258921a4f7597bb2",
                    "name": "New Agency Onboarding"
                },
                {
                    "ID": "6419b8b9001151ee258921a4f7597bc3",
                    "name": "New Agency Offboarding"
                }
            ]
        },
        {
            "objCode": "PTLTAB",
            "entities": [
                {
                    "ID": "645e6435000b4aaebe4776f4a42ed5ad",
                    "name": "Agency Performance and Readiness"
                }
            ]
        }
    ]
}

Réponse

200

{
    "data": {
        "id": "1d5693b9-b7b5-492d-8219-c21f34bcaca6",
        "name": "Agency Onboarding - 2023-06-06",
        "description": "This promotion package contains configuration to support the agency onboarding processes...",
        "source": "https://{domain}.{environment}.workfront.com",
        "status": "ASSEMBLING",
        "version": 1,
        "createdAt": "2023-06-06T17:29:21.600Z",
        "createdById": "61aa9d0e0005fcee8f212835bdaa2619",
        "publishedAt": null,
        "customerId": "61aa9d090005fa42152c1cb66659f38d"
    }
}

Obtenir une liste de packages

GET /packages

Cet appel renvoie une liste non filtrée des packages de promotion appartenant à la cliente ou au client.

La réponse comprend tous les packages créés à partir de n’importe quelle instance de sandbox, de prévisualisation ou de production de la cliente ou du client de Workfront.

URL

GET https://{domain}.{environment}.workfront.com/environment-promotion/api/v1/packages

En-têtes

{
    "apikey": "**********"
}

Ou

{
    "sessionID": "*****************"
}

Corps

Vide

Réponse

200

{
    "data": [
        {
            "id": "1d5693b9-b7b5-492d-8219-c21f34bcaca6",
            "name": "Agency Onboarding - 2023-06-06",
            "description": "This promotion package contains configuration to support the agency onboarding processes...",
            "status": "ASSEMBLING",
            "createdAt": "2023-06-06T17:29:21.600Z",
            "deletedAt": null
},
        {...}
    ]
}

<!-- Vérifier le « statut » ci-dessus. A-t-il été ajouté ? -->

Obtenir un package par ID

GET /packages/{id}

Cet appel renvoie les détails d’un package de promotion demandé.

La demande peut être effectuée par l’intermédiaire de n’importe quel environnement, quelle que soit la source d’origine du package de promotion.

URL

GET https://{domain}.{environment}.workfront.com/environment-promotion/api/v1/packages/{id}

En-têtes

{
    "apikey": "**********"
}

Ou

{
    "sessionID": "*****************"
}

Corps

Vide

Réponse

200

{
    "data": {
        "id": "1d5693b9-b7b5-492d-8219-c21f34bcaca6",
        "name": "Agency Onboarding - 2023-06-06",
        "description": "This promotion package contains configuration to support the agency onboarding processes...",
        "source": "https://{domain}.{environment}.workfront.com",
        "status": "DRAFT",
        "version": 1,
        "createdAt": "2023-06-06T17:29:21.600Z",
        "publishedAt": null,
        "customerId": "61aa9d090005fa42152c1cb66659f38d",
        "packageEntities": {
            "GROUP": [
               {
                   "id": "52aa9d0e0005fcee8f212835bdaa2691",
                   "name": "Default Group",
                   "description": "null"
                   - or -
                   "description": "..."
               }
            ],
            "ROLE": [
               {...}
            ],
            ...
        }
   }
}

Mettre à jour les propriétés spécifiques d’un package

PATCH /packages/{id}

Cet appel met à jour tout le contenu du package de promotion fourni dans le corps PATCH.

Les attributs modifiables sont les suivants :

  1. name (chaîne)
  2. description (chaîne)
  3. status (chaîne avec validation de valeur)

Pour une description détaillée des statuts disponibles, voir Statuts de promotion environnementale dans l’article Vue d’ensemble du déplacement d’objets entre des environnements Workfront.

URL

PATCH https://{domain}.{environment}.workfront.com/environment-promotion/api/v1/packages/{id}

En-têtes

{
    "apikey": "**********",
    "Content-Type": "application/json"
}

Ou

{
    "sessionID": "*****************",
    "Content-Type": "application/json"
}

Corps

{
    "status": "ACTIVE"
}

Réponse

200

{
    "data": {
        "id": "1d5693b9-b7b5-492d-8219-c21f34bcaca6",
        "name": "Agency Onboarding - 2023-06-06",
        "description": "This promotion package contains configuration to support the agency onboarding processes...",
        "source": "https://{domain}.{environment}.workfront.com",
        "status": "ACTIVE",
        "version": 1,
        "createdAt": "2023-06-06T17:29:21.600Z",
        "publishedAt": "2023-06-06T19:39:01.600Z",
        "customerId": "61aa9d090005fa42152c1cb66659f38d",
        "packageEntities": {
            "GROUP": [
               {
                   "id": "52aa9d0e0005fcee8f212835bdaa2691",
                   "name": "Default Group",
                   "description": "..."
               }
            ],
            "ROLE": [
               {...}
            ],
            ...
        }
   }
}

Supprimer un package

DELETE /packages/{id}

Cet appel supprime l’enregistrement du package de promotion. Cette action est irréversible.

NOTE
Plutôt que de supprimer un package de promotion, il est recommandé de définir le statut du package sur DÉSACTIVÉ. Cela permet de récupérer le package et de conserver l’historique d’installation de l’emplacement où il a été déployé.

URL

DELETE https://{domain}.{environment}.workfront.com/environment-promotion/api/v1/packages/{id}

En-têtes

{
    "apikey": "**********"
}

Ou

{
    "sessionID": "*****************"
}

Corps

Vide

Réponse

200

Deleted

Effectuer une exécution préalable

IMPORTANT
Avant de pouvoir exécuter une installation, vous devez effectuer cette exécution préalable. Vous utiliserez l’ID généré par cet appel lorsque vous exécuterez l’installation.
POST {customer-domain}/environment-promotion/api/v1/packages/{id}/prepare-installation

Cet appel effectue une comparaison entre la définition de package et l’environnement cible identifié dans l’URL.

Le résultat est un corps JSON qui identifie si un objet de promotion est trouvé ou non dans l’environnement cible.

Pour chaque objet de promotion, l’une des actions suivantes est définie :

CREATE

Lorsqu’un enregistrement correspondant est introuvable dans l’environnement cible, l’action est définie sur CREATE.

Lorsque cette action est définie dans le translationmap qui est fourni au point d’entrée /install, le service d’installation crée l’enregistrement.

USEEXISTING

Lorsqu’un enregistrement correspondant est trouvé dans l’environnement cible, l’action est définie sur USEEXISTING et un targetId est également capturé dans le translationmap.

Lorsque cette action est définie dans le translationmap qui est fourni au point d’entrée /install, le service d’installation ne crée pas l’enregistrement. Il utilisera toutefois le targetId inclus dans l’entrée de mappage pour d’autres objets qui peuvent faire référence à cet enregistrement.

Par exemple, un « Groupe par défaut » peut être trouvé dans l’environnement cible dans lequel un package est déployé. Il n’est pas possible d’avoir deux enregistrements « Groupe par défaut ». Le service d’installation utilisera donc le GUID du groupe existant dans toute autre action de création d’objet qui inclura une référence au « Groupe par défaut », comme un projet, un formulaire ou toute autre entité liée à ce groupe.

Remarque :

  • Lorsque l’action USEEXISTING est affectée, l’enregistrement existant dans l’environnement cible n’est pas modifié.

    Par exemple, si la description du « Groupe par défaut » a changé dans le sandbox à partir duquel le package a été créé et que la valeur de description est différente dans l’environnement cible, la valeur reste inchangée après une installation avec ce translationmap.

OVERWRITING

Cette action n’est pas définie automatiquement.

Cette action permet de mettre à jour un objet existant dans l’environnement cible. Elle permet de remplacer manuellement une action CREATE ou USEEXISTING affectée avant d’appeler le /install.

  • Un utilisateur ou une utilisatrice peut mettre à jour un objet dans l’environnement de test, puis utiliser l’action OVERWRITING pour mettre à jour cet objet dans l’environnement cible.

  • Si l’utilisateur ou l’utilisatrice installe d’abord un package de promotion, puis qu’un nouveau package (ou un package mis à jour) contient des modifications apportées aux objets dans le package initial, l’utilisateur ou l’utilisatrice peut utiliser l’action OVERWRITING pour remplacer les objets précédemment installés.

    Pour plus d’informations sur le remplacement, voir la section [Remplacement](#overwriting) de cet article.

IGNORE

Cette action n’est pas définie automatiquement.

Elle permet de remplacer manuellement une action CREATE ou USEEXISTING affectée avant d’effectuer l’appel /install.

Remarques :

  • Si un enregistrement qui était initialement défini sur CREATE est défini sur IGNORE, tous les enregistrements enfants doivent également être définis sur IGNORE.

    Par exemple, si un enregistrement de modèle a été mappé avec une action CREATE et que l’utilisateur ou l’utilisatrice qui procède à l’installation souhaite l’exclure du déploiement, il ou elle peut définir l’action du modèle sur IGNORE.

    Dans ce cas, si l’utilisateur ou l’utilisatrice qui procède à l’installation ne définit pas également les tâches de modèle, les affectations de tâches de modèle, les tâches antérieures de modèle, la définition de la file d’attente, les rubriques de file d’attente, les règles de routage, etc. sur IGNORE, le déploiement entraîne l’échec de la tentative d’installation.

  • Si un enregistrement qui était initialement défini sur USEEXISTING est défini sur IGNORE, il peut y avaoir des effets négatifs pendant le processus d’installation.

    Par exemple, si un enregistrement de groupe a été mappé avec l’action USEEXISTING et que l’utilisateur ou l’utilisatrice qui procède à l’installation définit l’action sur IGNORE pour les objets qui nécessitent un groupe (par exemple, un projet ne peut pas exister sans qu’un groupe soit affecté), le groupe par défaut du système est affecté à ce projet.

  • Si un enregistrement qui était initialement défini sur USEEXISTING est défini sur CREATE, il peut y avoir des effets négatifs pendant le processus d’installation, car de nombreuses entités Workfront ont des contraintes de nom unique.

    Par exemple, si un enregistrement de « Groupe par défaut » a été mappé avec l’action USEEXISTING et que l’utilisateur ou l’utilisatrice qui procède à l’installation définit l’action sur CREATE, du fait qu’il existe déjà un « Groupe par défaut », la tentative d’installation échoue à toutes les étapes. Les noms de groupe doivent être uniques.

    Certaines entités n’ont pas de contrainte de nom unique. Pour ces objets, cette modification entraîne deux enregistrements portant le même nom. Par exemple, les modèles, les projets, les vues, les filtres, les regroupements, les rapports et les tableaux de bord n’ont pas de contraintes de nom unique. Une bonne pratique consiste à attribuer des noms uniques à ces enregistrements, mais cela n’est pas exigé.

L’action UPDATE n’est actuellement pas prise en charge dans les fonctionnalités alpha de ce service. L’option permettant d’autoriser une action UPDATE est actuellement en cours de recherche.

URL

POST https://{domain}.{environment}.workfront.com/environment-promotion/api/v1/packages/:id/prepare-installation

En-têtes

{
    "apikey": "**********",
    "Content-Type": "application/json"
}

Ou

{
    "sessionID": "*****************",
    "Content-Type": "application/json"
}

Corps

{}

Réponse

200

{
    "environmentPromotionPackageId": "45f2ae94-76c0-4b13-8f3b-f688de83043d",
    "environmentPromotionPackageVersion": 1,
    "id": "c0bc79bd-c9c1-4b5b-b118-b1241392de0e",
    "userId": "5ba38da500b752fd66439d4f6a9999a1",
    "customerId": "5ba38d9d00b74f0c7a38b1b487fc9710",
    "status": "PREPARING",
    "environment": "mmi.my.workfront.com",
    "registeredAt": "2023-10-19T20:00:16.697Z",
    "updatedAt": "2023-10-19T20:00:16.701Z",
    "translationMap": {
        "CTGY": {
            "62d9c9a0000013aeeefe7242a0a5fdb2": {
                "name": "Example Document Form",
                "action": "USEEXISTING",
                "isValid": true,
                "targetId": "62d9c9a0000013aeeefe7242a0a5fdb2"
            }
        },
        "PGRP": {
            "62d1eee4001c6618e6b9f9a588ba1598": {
                "name": "Asset Detail",
                "action": "USEEXISTING",
                "isValid": true,
                "targetId": "62d1eee4001c6618e6b9f9a588ba1598"
            }
        },
        "GROUP": {
            "5ba38da500b752b0f46d13186030b7ad": {
                "name": "Default Group",
                "action": "USEEXISTING",
                "isValid": true,
                "targetId": "5ba38da500b752b0f46d13186030b7ad"
            }
        },
        "PARAM": {
            "62d1eee400f8578895166ee91a83f97a": {
                "name": "Asset Type",
                "action": "USEEXISTING",
                "isValid": true,
                "targetId": "62d1eee400f8578895166ee91a83f97a"
            },
            "62d1eee50001407c713514a8970b58e4": {
                "name": "Keywords",
                "action": "USEEXISTING",
                "isValid": true,
                "targetId": "62d1eee50001407c713514a8970b58e4"
            },
            "62d1eee5000333ac3981ea4f3df6d88e": {
                "name": "Permitted Uses",
                "action": "USEEXISTING",
                "isValid": true,
                "targetId": "62d1eee5000333ac3981ea4f3df6d88e"
            },
            "62d1eee5000b188e9ec8039a097fc7ab": {
                "name": "File Format",
                "action": "USEEXISTING",
                "isValid": true,
                "targetId": "62d1eee5000b188e9ec8039a097fc7ab"
            },
            "62d1eee500100c159fd5f838ce560507": {
                "name": "CTA",
                "action": "USEEXISTING",
                "isValid": true,
                "targetId": "62d1eee500100c159fd5f838ce560507"
            },
            "62d9c988001c1f23954dbb9d646335b5": {
                "name": "Other CTA",
                "action": "USEEXISTING",
                "isValid": true,
                "targetId": "62d9c988001c1f23954dbb9d646335b5"
            },
            "62d9c9880070f546cf4c798ea6c3eaa4": {
                "name": "Other Audience",
                "action": "USEEXISTING",
                "isValid": true,
                "targetId": "62d9c9880070f546cf4c798ea6c3eaa4"
            },
            "62d9c990006258baf1b40f2569c3eab7": {
                "name": "Target Audience",
                "action": "USEEXISTING",
                "isValid": true,
                "targetId": "62d9c990006258baf1b40f2569c3eab7"
            }
        }
    }
}
NOTE
L’identifiant dont vous aurez besoin pour effectuer l’installation est le champ id. Dans cet exemple, le champ id est le troisième à partir du haut et a une valeur commençant par c0bc79bd.

Exécuter une installation

IMPORTANT
Avant de pouvoir exécuter une installation, vous devez effectuer cette exécution préalable. Vous utiliserez l’identifiant généré à partir de l’exécution préalable lorsque vous effectuerez l’installation.
Si des modifications ont été apportées à l’environnement de destination (l’environnement sur lequel le package est déployé) après le lancement de l’exécution préalable, nous vous recommandons de lancer à nouveau l’exécution préalable. Si vous ne la lancez pas, votre exécution risque de ne pas s’achever correctement ou l’installation peut échouer.
Pour plus d’informations sur le lancement d’une exécution préalable, consultez la section Effectuer une exécution préalable.
POST /install

Cet appel lance une tentative d’installation d’un package de promotion dans l’environnement cible identifié dans l’URL de la requête POST.

URL

POST https://{domain}.{environment}.workfront.com/environment-promotion/api/v1/installations/{id}/install

En-têtes

{
    "apikey": "**********",
    "Content-Type": "application/json"
}

Ou

{
    "sessionID": "*****************",
    "Content-Type": "application/json"
}

Corps

{
}

Réponse

202

{}

Obtenir la liste des installations pour un package spécifique

GET /v1/installations?environmentPromotionPackageId={environmentPromotionPackageId}

Les résultats incluent les événements d’installation de tous les environnements dans lesquels le package a été déployé. Ils ne se limitent pas aux installations pour l’environnement dans lequel la demande est effectuée. Vous pouvez ainsi identifier les environnements qui ont reçu ce package.

URL

GET https://{domain}.{environment}.workfront.com/environment-promotion/api/v1/installations?environmentPromotionPackageId={environmentPromotionPackageId}

En-têtes

{
    "apikey": "**********"
}

Ou

{
    "sessionID": "*****************"
}

Corps

Vide

Réponse

200

[
    {
        "id": "2892b936-e09e-455a-935f-e1462ab9753c",
        "environmentPromotionPackageId": "4fae2b9d-d315-45f4-909f-a0c0d79fc65d",
        "environmentPromotionPackageVersion": 1,
        "userId": "8fbbc5bcf4f94a5b862483ee05573e73",
        "customerId": "54286d78b064451096752b99bf968481",
        "status": "INSTALLED",
        "environment": "https://{domain}.{environment}.workfront.com",
        "registeredAt": "2021-03-16T02:21:31.908Z",
        "updatedAt": null,
        "translationMap": {
            "ROLE": {
                "5f6d114f006883209828ddd9088e63b3": {
                    "name": "DAM Curator",
                    "action": "USEEXISTING",
                    "isValid": true,
                    "targetId": "600f4bed00028a718599f29575840053"
                },
                "ad535a9ebe647361e053a7656a0a1575": {
                    "name": "Copywriter",
                    "action": "USEEXISTING",
                    "isValid": true,
                    "targetId": "600f162700001ca051081c06667b14a4"
                },
                ...
            },
            "TMPL": {
                "5f9b317c00b3db5af69abcd1ed5f82aa": {
                    "name": "Digital Asset Production (Integrated)",
                    "action": "CREATE",
                    "isValid": true,
                    "targetId": "6054cda40000d5af63dc811d9c2b3a07"
                },
                ...
            },
            ...
        }
    },
    {...}
]

Obtenir les détails d’une installation

GET /installations/{id}

Cet appel renvoie la valeur finale translationMap créée par le service d’installation pour une installation spécifique.

Chaque enregistrement indique la nature de l’action prescrite et si cette action a réussi ou non.

Pour les enregistrements avec une action CREATE, le champ targetId est défini sur la valeur de l’enregistrement nouvellement créé dans le système cible. En outre, le champ installationStatus est défini sur INSTALLED.

Pour les enregistrements avec une action action USEEXISTING, le champ targetId est également défini. Le champ installationStatus est défini sur REGISTERED. Cela signifie que le processus de mappage est terminé et que le service d’installation reconnaît avoir évalué l’enregistrement et qu’aucune action n’est nécessaire.

Si l’enregistrement comporte une action CREATE, mais qu’elle ne parvient pas à créer l’enregistrement, le champ installationStatus est défini sur FAILED et la raison de l’échec est également fournie.

URL

GET https://{domain}.{environment}.workfront.com/environment-promotion/api/v1/installations/{id}

En-têtes

{
    "apikey": "**********"
}

Ou

{
    "sessionID": "*****************"
}

Corps

Vide

Réponse

200

{
    "id": "2892b936-e09e-455a-935f-e1462ab9753c",
    "environmentPromotionPackageId": "4fae2b9d-d315-45f4-909f-a0c0d79fc65d",
    "environmentPromotionPackageVersion": 1,
    "userId": "8fbbc5bcf4f94a5b862483ee05573e73",
    "customerId": "54286d78b064451096752b99bf968481",
    "status": "INSTALLED",
    "environment": "https://{domain}.{environment}.workfront.com",
    "registeredAt": "2021-03-16T02:21:31.908Z",
    "updatedAt": null,
    "translationMap": {
        "ROLE": {
            "5f6d114f006883209828ddd9088e63b3": {
                "name": "DAM Curator",
                "action": "USEEXISTING",
                "isValid": true,
                "targetId": "600f4bed00028a718599f29575840053"
            },
            ...
        },
        "TMPL": {
            "5f9b317c00b3db5af69abcd1ed5f82aa": {
                "name": "Digital Asset Production (Integrated)",
                "action": "CREATE",
                "isValid": true,
                "targetId": "6054cda40000d5af63dc811d9c2b3a07"
            },
            ...
        },
        ...
    }
}

Remplacement

C'est un processus en trois étapes.

  1. Création d’une carte de traduction (analogue à la phase de préparation de l’installation)
  2. Modifiez la carte de traduction générée, en définissant les champs action et targetId pour tout objet qu’ils souhaitent remplacer. L’action doit être OVERWRITING et targetId doit être l’uuid de l’objet qui doit être remplacé.
  3. Exécutez l’installation.

Étape 1 - Création d’une carte de traduction

URL

POST https://{domain}.{environment}.workfront.com/environment-promotion/api/v1/packages/{id}/translation-map

Corps

Aucun

Réponse

Une carte de traduction, avec un état 202 - OK

{
    {objcode}: {
        {object uuid}: {
            "targetId": {uuid of object in destination},
            "action": {installation action},
            "name": {name of the object},
            "isValid": true
        },
        {...more objects}
    },
    {...more objcodes}
}

Exemple

{
    "UIVW": {
        "109f611680bb3a2b0c0a8c1f5ec63f6d": {
            "targetId": "6643a26b0001401ff797ccb318f97aa6",
            "action": "CREATE",
            "name": "Actual Portfolio Cost by Program",
            "isValid": true
        }
    },
    "UIGB": {
        "edb4c6c127d38910e4860eb25569a5cc": {
            "targetId": "6643a26b000178fb5cc27b74cc1e87ec",
            "action": "USEEXISTING",
            "name": "Actual Portfolio Cost by Program",
            "isValid": true
        }
    },
    "UIFT": {
        "f97b662e229fd09ee595d8d359ec88bd": {
            "targetId": "6643a26b00015cdd6727b76d6fda1d1d",
            "action": "USEEXISTING",
            "name": "Actual Portfolio Cost by Program",
            "isValid": true
        }
    },
    "PTLSEC": {
        "4bb80aa88a96420296a7f47bf866f162": {
            "targetId": "4bb80aa88a96420296a7f47bf866f162",
            "action": "USEEXISTING",
            "name": "Actual Portfolio Cost by Program",
            "isValid": true
        }
    },
    "EXTSEC": {
        "65f8637900015e4dceb6fe079bd5409d": {
            "targetId": "65f8637900015e4dceb6fe079bd5409d",
            "action": "USEEXISTING",
            "name": "Asnyc List",
            "isValid": true
        }
    },
    "PTLTAB": {
        "65f8638a00016422a83ddc3508852d0f": {
            "targetId": "65f8638a00016422a83ddc3508852d0f",
            "action": "CREATEWITHALTNAME",
            "name": "Cool 2.0 The Best",
            "isValid": true
        }
    }
}

Étape 2 - Modification de la carte de traduction

Il n’existe aucun point de terminaison pour cette étape.

  1. Dans la carte de traduction renvoyée dans Etape 1 - Créer une carte de traduction, examinez la liste des objets qui seront installés.

  2. Mettez à jour le champ d’action sur chaque objet pour l’action d’installation souhaitée.

  3. Validez le targetId sur chaque objet. Si l’action définie est USEEXISTING ou OVERWRITING, targetId doit être défini sur l’UUID de l’objet cible dans l’environnement de destination. Pour toute autre action, le targetId doit être une chaîne vide.

    note note
    NOTE
    targetId est déjà renseigné si une collision a été détectée.

Étape 3 - Installation

URL

POST https://{domain}.{environment}.workfront.com/environment-promotion/api/v1/packages/{id}/install

Corps

Il s’agit d’un objet avec un seul champ translationMap, qui doit être égal à la carte de traduction modifiée de Etape 2 - Modifier la carte de traduction.

{
    "translationMap": {
        {objcode}: {
            {object uuid}: {
                "targetId": {uuid of object in destination},
                "action": {installation action},
                "name": {name of the object},
                "isValid": true
            },
            {...more objects}
        },
        {...more objcodes}
    }
}

Exemple

{
    "translationMap": {
    "UIVW": {
        "109f611680bb3a2b0c0a8c1f5ec63f6d": {
            "targetId": "6643a26b0001401ff797ccb318f97aa6",
            "action": "USEEXISTING",
            "name": "Actual Portfolio Cost by Program",
            "isValid": true
        }
    },
    "UIGB": {
        "edb4c6c127d38910e4860eb25569a5cc": {
            "targetId": "6643a26b000178fb5cc27b74cc1e87ec",
            "action": "USEEXISTING",
            "name": "Actual Portfolio Cost by Program",
            "isValid": true
        }
    },
    "UIFT": {
        "f97b662e229fd09ee595d8d359ec88bd": {
            "targetId": "6643a26b00015cdd6727b76d6fda1d1d",
            "action": "OVERWRITING",
            "name": "Actual Portfolio Cost by Program",
            "isValid": true
        }
    },
    "PTLSEC": {
        "4bb80aa88a96420296a7f47bf866f162": {
            "targetId": "4bb80aa88a96420296a7f47bf866f162",
            "action": "USEEXISTING",
            "name": "Actual Portfolio Cost by Program",
            "isValid": true
        }
    },
    "EXTSEC": {
        "65f8637900015e4dceb6fe079bd5409d": {
            "targetId": "65f8637900015e4dceb6fe079bd5409d",
            "action": "USEEXISTING",
            "name": "Asnyc List",
            "isValid": true
        }
    },
    "PTLTAB": {
        "65f8638a00016422a83ddc3508852d0f": {
            "targetId": "65f8638a00016422a83ddc3508852d0f",
            "action": "CREATEWITHALTNAME",
            "name": "Cool 2.0 The Best",
            "isValid": true
        }
    }
}
}

Réponse

La réponse inclut l’état {uuid of the created installation} et un état 202 - ACCEPTED.

Exemple : b6aa0af8-3520-4b25-aca3-86793dff44a6

recommendation-more-help
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43