Mettre à jour une tâche avec une nouvelle version d'artefact - Cloud

Mettre à jour la version de l'artefact dans les tâches via l'API

Version
Cloud
Language
Français (France)
Product
Talend Cloud
Module
Talend API Designer
Talend API Tester
Talend Data Preparation
Talend Data Stewardship
Talend Management Console
Content
Création et développement > Updating Tasks
Utilisez l'endpoint executables/tasks/<task_id> pour mettre à jour une tâche avec une nouvelle version d'artefact.

Avant de commencer

Assurez-vous que le compte à utiliser pour émettre des appels d'API a l'autorisation Operations - Manage (Opérations - Gestion) (ID : TMC_OPERATOR).

Pourquoi et quand exécuter cette tâche

Dans cette section, Talend API Tester est utilisé pour démontrer la manière d'émettre des appels d'API pour obtenir la liste des tâches.

Procédure

  1. Dans la page Users (Uilisateurs), générez un jeton d'accès personnel pour votre compte, si cela n'est pas encore fait.
  2. Ouvrez Talend API Tester dans votre navigateur et sélectionnez PUT, dans la liste Method (Méthode).
  3. Dans le champ près de la liste déroulante Method (Méthode), saisissez l'endpoint à utiliser : https://api.<your_environment>.cloud.talend.com/tmc/v2.6/executables/tasks/<task_id>.
  4. Dans la zone HEADERS (EN-TÊTES), cliquez sur Add header (Ajouter un en-tête). Dans le champ name (nom) qui s'affiche, saisissez Authorization et dans le champ value (valeur), saisissez Bearer, ainsi que votre jeton d'accès personnel. Saisissez un espace afin de séparer Bearer de votre jeton d'accès personnel.
  5. Dans la zone BODY (CORPS), saisissez le nom de la tâche à mettre à jour, l'ID de l'espace de travail et l'ID du nouvel artefact à utiliser.

    Exemple

    {
      "name": "task_name",
      "description": "",
      "workspaceId": "workspace_id",
    
      "artifact": {
        "id": "id_of_the_artifact_to_be_updated",    
        "version": "target_version_of_this_artifact (for example, 0.1.22.20212710014123)"
      }
    }
    Cet exemple contient les paramètres requis pour mettre une tâche à jour.

    Le paramètre artifactId identifie l'artefact à mettre à jour et le paramètre workspaceId indique l'espace de travail duquel obtenir les tâches. Vous les obtenez via des requêtes d'API ou les trouvez dans Talend Cloud Management Console.

    • API :
      • utilisez GET sur l'endpoint https://api.<your_environment>.cloud.talend.com/v2.6/artifacts pour les artefacts
      • utilisez GET sur l'endpoint https://api.<your_environment>.cloud.talend.com/v2.6/workspaces pour les espaces de travail
    • Dans Talend Cloud Management Console, ouvrez la liste d'artefacts depuis l'espace de travail puis ouvrez l'artefact à mettre à jour pour voir son ID. L'ID de l'espace de travail s'affiche dans l'URL de la page Edit workspace (Modifier l'espace de travail).
  6. Cliquez sur Send (Envoyer) pour envoyer votre requête de mise à jour de la tâche.

Résultats

Le code de statut 200 est retourné avec les détails de la tâche dans le corps de la réponse. Vous pouvez voir que le nouvel artefact est utilisé. L'exemple suivant vous montre à quoi ressemble une tâche dans la réponse.
{
  "id": "5c1111d7a4186a4eafed0587",
  "name": "Hello world task",
  "description": "task detail description",
  "workspace": {
    "id": "57f64991e4b0b689a64feed2",
    "name": "Personal",
    "description": "workspace detail description",
    "owner": "admin",
    "type": "custom",
    "environment": {
      "id": "57f64991e4b0b689a64feed3",
      "name": "Development",
      "description": "environment detail description",
      "default": true
    }
  },
  "version": "0.1",
  "artifact": {
    "createDate": "2021-11-22T13:13:27.608Z",
    "updateDate": "2021-11-22T13:13:27.608Z",
    "id": "id_of_the_artifact_to_be_updated",
    "name": "my_artifact",
    "version": "0.1.22.20212710014123" (The new  artifact version)
  },
  "tags": [
    "tag1",
    "tag2"
  ],
  "connections": {
    "aws": "5d405e381f40e07fbab6757c",
    "googledrive": "5d405e831f40e07fbab6757d"
  },
  "parameters": {
    "parameter_p1": "1111",
    "custom_parameter": "custom"
  },
  "resources": {
    "resource_file_f1": "5d567ad48f68ae1a1e16e4a4"
  },
  "autoUpgradeInfo": {
    "autoUpgradable": false,
    "overrideWithDefaultParameters": false
  }
}

Dans un scénario d'utilisation réelle, vous pouvez développer votre propre script pour émettre automatiquement cette requête sur chaque tâche récupérée dans la section précédente : Obtenir les tâches pour lesquelles vous souhaitez mettre à jour la version de l'artefact.

Dans l'onglet Downloads (Téléchargements) à gauche, vous pouvez télécharger un exemple de script, ajouter les valeurs appropriées aux paramètres requis listés au début du script et l'utiliser pour automatiser la mise à jour de vos tâches. Ce script est conçu à des fins de démonstration uniquement. Talend ne fournit pas de service de support relatif à ceci.