メインコンテンツにスキップ
ドキュメント
ドキュメント
Adaptive Planning
最終更新: 2025-02-07
参考: タスク

参考: タスク

URL エンドポイント

https://api.adaptiveinsights.com/api/rest/tasks/v1/<tenant>/tasks?instanceCode=<instanceCode>
バージョン: v1
カテゴリ
インテグレーション タスクのトリガ、およびタスクの実行を含むタスクの詳細の取得
説明
インテグレーション タスクでの JSON ベースの HTTP 操作
呼び出すために必要な権限
データ デザイナー、インテグレーション オペレーター
リクエストに必要なパラメータ
GET、POST: インテグレーション タスク ID、インテグレーション タスクの実行 ID
インテグレーション タスクを取得または更新します。

サポートされている HTTP VERB

HTTP Verb
単一リソース
回収リソース
説明
GET
サポート済
サポート済
タスク情報を取得します。タスクの実行詳細を取得します。
POST
サポート済
サポートされていません
インテグレーション タスクをトリガします。

GET <タスク詳細>

取得タスク詳細
リクエスト URI
/api/REST/v1/{tenant}/tasks: インスタンスで定義されたインテグレーション タスクの詳細を取得します。
テナントのすべてのインテグレーション タスクを取得します。
リクエスト URI の例:
https://api.adaptiveinsights.com/api/rest/tasks/v1/<tenant>/tasks?instanceCode=<instanceCode>
リクエスト ヘッダーの例
認証: 基本ベースまたはトークンベース
リクエスト本文の例
該当なし
パス パラメータ
名前
説明
テナント
顧客インスタンス コード
クエリー パラメータ
名前
説明
必須
limit
結果に含めるインテグレーション タスクの数。
  • タイプ: 数値
  • 最小: 1
  • 最大値: 100
  • 例: limit=50
なし
offset
結果にタスクが含まれるように開始する前にスキップするタスクの数。
  • 最小: 0
  • example: offset=0
なし
taskType
取得したタスクをタスク タイプ別にフィルタします。
  • インテグレーション
  • example: taskType=integration
なし
回答
タスクのリスト
成功したタスクの GET 応答の例
HTTP/1.1 200 Ok
Content-Type: application/json

{
 "count": 3,
 "data": [
     {
         "id": "integration4",
         "taskType": "integration",
         "name": "An Integration Task"
     },
     {
         "id": "integration111",
         "taskType": "integration",
         "name": "Another Integration Task"
     },
     {
         "id": "integration43",
         "taskType": "integration",
         "name": "Also Another Integration Task"
     }
 ]
}
回答ペイロード
名前
説明
カウント
(この回答に含まれるタスクだけでなく) 顧客インテグレーション タスクの合計数。
タイプ: 数値
データ
インテグレーション タスクの集合。
  • タイプ: 配列
  • タイプ定義:
    • ID: インテグレーション タスクの一意の識別子。
    • 名前: インテグレーション タスクの名前。
失敗した回答
不良タスク リクエストの回答の例
{
 "type" : "validation-error",
 "title": "invalid request",
 "errors" : [
     {
         "message" : "must be a non-negative integer",
         "parameter" : "offset"
     },
     {
         "message" : "must be positive integer no greater than 100",
         "parameter" : "limit"
     },
     {
         "message" : "must be a valid task type",
         "parameter" : "kind"
     }
 ]
}
回答ペイロードの場所
回答ペイロード
名前
説明
type
エラーのタイプ。
title
エラーを説明するテキスト。
エラー
リクエスト内で見つかったエラーの集合。
  • タイプ: 配列
  • タイプ定義:
    • message: エラーを説明するメッセージ。
    • parameter: エラーが関連付けられたパラメータ。

POST

タスク実行のトリガ
リクエスト URI
渡されたタスク識別子によって表されるタスクの実行をトリガします。
/{taskId}/runs
リクエスト URI の例:
https://api.adaptiveinsights.com/api/rest/tasks/v1/{tenant}/tasks/integration111/runs?instanceCode=<instanceCode>
この例では、taskId は Integration111 です。
リクエスト ヘッダーの例
認証: 基本ベースまたはトークンベース
コンテンツ タイプ: application/json
リクエスト本文の例
リクエスト本文が必要です。空にすることはできません。
リクエスト本文
{ }
パス パラメータ
名前
説明
必須
taskId
トリガされているタスクのタスク ID。
あり
回答例
正常にトリガされたタスクの実行の応答
HTTP/1.1 201 Created
Content-Type: application/json

{
 "id": "taskrun456",
 "status": "Completed"
}

GET <タスクの実行詳細>

タスクの実行詳細の取得
リクエスト URI
渡されたタスク識別子によって表されるタスク実行の詳細を取得します。
/{taskId}/runs/{taskRunId}
リクエスト URI の例:
https://api.adaptiveinsights.com/api/rest/tasks/v1/{tenant}/tasks/integration111/runs/taskrun456?instanceCode=<instanceCode>
この例では、以下の ID を使用します。
ID
値
taskId
integration111
taskRunId
taskrun456
パス パラメータ
名前
説明
taskId
実行されたインテグレーション タスクの一意の識別子。
taskRunId
タスク実行の一意の識別子。
回答例
タスクの実行応答の取得に成功しました
{
 "id": "taskrun456",
 "status": "Completed"
}
回答ペイロード
名前
説明
ID
このインテグレーション タスクの実行の一意の識別子。
ステータス
タスク実行のステータス (以下のいずれか)
  • なし
  • 保留中
  • 進行中
  • キャンセル中
  • キャンセル済
  • 完了
  • 失敗