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
Product
Talend Cloud
Module
Talend Management Console
Content
Création et développement > Updating Tasks
Last publication date
2024-02-12
Utilisez l'endpoint orchestration/executables/tasks/<task_id> pour mettre à jour une tâche avec une nouvelle version d'artefact.

Procédure

Émettez la requête suivante pour obtenir les exécutions planifiées des tâches d'un environnement donné.

Exemple

method: PUT
endpoint: https://api.<env>.cloud.talend.com/orchestration/executables/tasks/<task_id>
headers: {
          "Content-Type": "application/json",
          "Authorization": "Bearer <your_personal_access_token_or_service_account_token>"
          }
payload: {
  "name": "task_name",
  "description": "",
  "workspaceId": "workspace_id",

  "artifact": {
    "id": "id_of_the_artifact_that_the_task_uses",    
    "version": "target_version_of_this_artifact (for example, 0.1.22.20212710014123)"
  }
}
Cet exemple contient seulement le nombre minimal de paramètres pour une tâche. Lorsque vous mettez vos tâches à jour, assurez-vous d'inclure toutes les entités de la tâche dans le payload, c'est-à-dire tous les champs existants des tâches à mettre à jour. Sinon, les valeurs des champs de vos tâches qui ne sont pas incluses sont remplacées par des valeurs nulles.

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.