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

APIを経由してタスクでアーティファクトのバージョンをアップデート
Version
Cloud
Language
日本語
Product
Talend Cloud
Module
Talend Management Console
Content
ジョブデザインと開発 > Updating Tasks
Last publication date
2024-02-09
workspaceIdクエリーパラメーターとartifactIdクエリーパラメーターと共にorchestration/executables/tasksエンドポイントを使い、アップデートされるアーティファクトを使用しているタスクのリストを取得します。

始める前に

  • TMCトークンを生成:

    生成されたサービスアカウントトークンは30分後に期限切れになります。期限切れになった場合は、エンドポイントhttps://api.<env>.cloud.talend.com/security/oauth/tokenでPOSTメソッドを使って新しいトークンを生成します。トークンの生成に関する詳細は、サービスアカウントトークンを生成をご覧ください。

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

手順

  1. 次のリクエストを発行し、指定された環境でスケジュールされたタスク実行を取得します。

    例

    method: GET
endpoint: https://api.<env>.cloud.talend.com/orchestration/executables/tasks
headers: {
          "Content-Type": "application/json",
          "Authorization": "Bearer <your_personal_access_token_or_service_account_token>"
          }
query parameters: {
         "workspaceId": "id_of_the_workspace"
         "artifactId": "id_of_the_artifact_that_the_task_will_be_updated_to_use"
                  }
    artifactIdパラメーターは、使用のためにタスクがアップデートされるアーティファクトを識別します。workspaceIdパラメーターは、タスクの取得元となるワークスペースを示します。タスクはAPIリクエストを介して取得するか、Talend Management Consoleで見つかります。
  2. オプション: Talend API Testerを使えば、APIリクエストを視覚的にビルドできます。

    例

  3. [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
  }
}