Mettre à jour une campagne à l'aide de l'API

Vous pouvez mettre à jour une campagne avec les modifications souhaitées. Vous pouvez modifier uniquement le mot-clé ou les participants.

Dans cet exemple, Talend API Tester est utilisé pour envoyer des requêtes.

Pour plus d'informations concernant Talend API Tester, consultez le Guide d'utilisation de Talend Cloud API Tester.

Procédure

Si vous n'avez pas encore de jeton d'accès personnel, générez-en un. Pour plus d'informations, consultez Générer un jeton d'accès personnel.
Ouvrez Talend API Tester dans votre navigateur.
Dans l'onglet Repository (Référentiel), sélectionnez Put dans la liste déroulante Method (Méthode).
Saisissez l'URL suivante : https://tds.{region}.cloud.talend.com/data-stewardship/api/v1/campaigns/owned

Vous pouvez voir une liste d'URL à utiliser pour chaque centre de données dans URL et régions de Talend Cloud.
Cliquez sur le bouton Add header, saisissez Authorization dans le champ name et Bearer suivi d'un espace, puis de votre jeton, dans le champ value.
Cliquez sur le bouton Add header et saisissez Cookie dans le champ name et laissez le champ value vide.

Dans le champ Body, incluez le corps depuis l'opération POST https://tds.{region}.cloud.talend.com/data-stewardship/api/v1/campaigns/owned utilisée pour créer la campagne, avec les modifications souhaitées.

Exemple

Pour ajouter le·a data steward steward2@account.com à l'étape de workflow New, ajoutez-le·a à la valeur Supervisor dans l'objet participants :

{
    "campaign": {
        "name": "my-campaign-resolution-created-via-api",
        "label": "Improve product catalog data quality (created via API)",
        "description": "Increase the level of data quality for each product catalog.",
        "owners": ["owner@account.com"],
        "taskType": "RESOLUTION",
        "schemaRef": {
            "namespace": "org.talend.schema",
            "name": "my_products_created_via_API",
            "version": 1,
            "displayName": "Product (created via API)"
        },
        "taskResolutionDelay": {
            "value": 10,
            "unit": "DAYS"
        },
        "workflow": {
            "name": "default workflow",
            "states": [{
                "name": "New",
                "label": "New",
                "transitions": [{
                    "name": "To validate",
                    "label": "To validate",
                    "targetStateName": "To validate",
                    "allowedRoles": ["Supervisor"]
                }],
                "allowedRoles": [],
                "translations": {}
            }, {
                "name": "To validate",
                "label": "To validate",
                "transitions": [{
                    "name": "Accept",
                    "label": "Accept",
                    "targetStateName": "Resolved",
                    "allowedRoles": ["Validator"]
                }, {
                    "name": "Reject",
                    "label": "Reject",
                    "targetStateName": "New",
                    "allowedRoles": ["Validator"]
                }],
                "allowedRoles": [],
                "translations": {}
            }, {
                "name": "Resolved",
                "label": "Resolved",
                "transitions": [],
                "allowedRoles": ["Validator"],
                "translations": {}
            }]
        }
    },
    "participants": {
        "Supervisor": ["steward1@account.com", "steward2@account.com"],
        "Validator": ["steward1@account.com"]
    }
}

Cliquez sur Send (Envoyer).

Résultats

L'API retourne un code HTTP 200 pour vous informer que la requête a bien été exécutée. La réponse comprend une description JSON mise à jour de la campagne.

Cette page vous a-t-elle aidé ?

Si vous rencontrez des problèmes sur cette page ou dans son contenu – une faute de frappe, une étape manquante ou une erreur technique – dites-nous comment nous améliorer !

Laissez vos commentaires ici