アーティファクトのバージョンを更新する必要があるタスクを取得 - Cloud

APIを経由してタスクでアーティファクトのバージョンを更新

Version
Cloud
Language
日本語 (日本)
Product
Talend Cloud
Module
Talend API Designer
Talend API Tester
Talend Data Preparation
Talend Data Stewardship
Talend Management Console
Content
ジョブデザインと開発 > Updating Tasks
executables/tasksエンドポイントを[workspaceId]クエリーパラメーターと[artifactId]クエリーパラメーターで使って、更新されるアーティファクトを使用しているタスクのリストを取得します。

始める前に

API呼び出しの発行に使用されるアカウントに[Operations - Manage] (操作-管理) (ID: TMC_OPERATOR)権限があることを確認します。

このタスクについて

このセクションでは、Talend API TesterはAPI呼び出しを発行してタスクのリストを取得する方法のデモンストレーションに使用されます。

手順

  1. [Users] (ユーザー)ページで、自分のアカウント用にパーソナルアクセストークンを生成します。
  2. ブラウザーでTalend API Testerを開き、[Method] (メソッド) リストで[GET]を選択します。
  3. [Method] (メソッド)ドロップダウンリストの横にあるフィールドに、使用するエンドポイントをhttps://api.<your_environment>.cloud.talend.com/v2.6/executables/tasksという形式で入力します。
  4. [HEADERS] (ヘッダー)エリアで[Add header] (ヘッダーを追加)をクリックし、表示される[name] (名前)フィールドにAuthorizationを、[value] (値)フィールドにBearerとパーソナルアクセストークンをそれぞれ入力します。Bearerとパーソナルアクセストークンは空白で区切ります。

    例え

  5. [Add query parameter] (クエリーパラメーターを追加)を2回クリックして2つの空のパラメーターを追加し、それぞれworkspaceIdartifactIdとして定義します。
    [artifactId]パラメーターは更新されるアーティファクトを識別して、[workspaceId]パラメーターはタスクを取得するワークスペースを示します。タスクはAPIリクエストを介して取得するか、Talend Cloud Management Consoleで見つかります。
    • API:
      • https://api.<your_environment>.cloud.talend.com/v2.6/artifactsGETを使う
      • ワークスペースのhttps://api.<your_environment>.cloud.talend.com/v2.6/workspacesGETを使う
    • Talend Cloud Management Consoleで、ワークスペースからアーティファクトリストを開いた後に、更新されるアーティファクトを開いて、そのIDを確認します。ワークスペースのIDは、[Edit workspace] (ワークスペースを編集)ページのURLに表示されます。
  6. [Send] (送信)をクリックして、このアーティファクトを使ってタスクをすべて取得するよう呼び出しを発行します。

タスクの結果

レスポンスのボディに、ステータスコード200がタスクのリストと共に返されます。以下の例では、レスポンス内にタスクがどのように表示されるかを示します。これらのタスクではすべて、新しいバージョンに更新されるアーティファクトを使用しています。
{
  "id": "your_task_id",
  "name": "Hello world task",
  "description": "task detail description",
  "workspace": {
    "id": "your_workspace_id",
    "name": "Personal",
    "description": "workspace detail description",
    "owner": "admin",
    "type": "custom",
    "environment": {
      "id": "your_environment_id",
      "name": "Development",
      "description": "environment detail description",
      "default": true
    }
  },
  "version": "0.1",
  "artifact": {
    "createDate": "2021-11-22T13:13:27.602Z",
    "updateDate": "2021-11-22T13:13:27.602Z",
    "id": "id_of_the_artifact_to_be_updated",
    "name": "Hello world artifact",
    "version": "0.1.0" (The artifact version to be updated)
  },
  "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
  }
}