REST APIリファレンス

前へ次へ

fetchStateジョブのステータスの取得

GET要求を使用して、fetchStateジョブのステータスを取得します。

GET要求

fetchStateジョブのステータスを取得するには、次のいずれかのURIを使用します。

fetchStateジョブのステータスを受け取るには、次のURIを使用します。<id>はfetchStateジョブのIDです。

/public/core/v3/fetchState/<job id>

fetchStateジョブ内の各オブジェクトの状態のステータスを受け取るには、次のURIを使用します。

/public/core/v3/fetchState/<job id>?expand=objects

状態がSUCCESSFULになるまで要求のポーリングを継続します。

GET応答

ステータスを要求すると、次のようなステータス情報が返されます。

フィールド	タイプ	説明
id	String	fetchStateジョブのID。
createTime	String	fetchStateジョブが作成された時刻。
updateTime	String	fetchStateジョブの最終更新時刻。
name	String	fetchStateジョブの名前。
startTime	String	fetchStateジョブの開始時刻。
endTime	String	fetchStateジョブの終了時刻。
status	複合型	fetchStateジョブのステータス。
state	String	ステータスのオブジェクトで返されます。「実行中」、「成功」、「失敗」など、fetchStateジョブの状態。
message	String	ステータスのオブジェクトで返されます。ジョブのステータスメッセージ。
objects	Collection	fetchStateジョブのオブジェクト。URIに ?expand=objects が含まれる場合に返されます。
id	String	objectsオブジェクトで返されます。要求されたオブジェクトのグローバル一意識別子。
name	String	objectsオブジェクトで返されます。オブジェクト名。
path	String	objectsオブジェクトで返されます。オブジェクトの完全なパス。
description	String	objectsオブジェクトで返されます。オブジェクトの説明。
status	複合型	objectsオブジェクトで返されます。オブジェクトのステータス。
state	String	objects.statusオブジェクトで返されます。「実行中」、「成功」、「失敗」、「スキップ」など、オブジェクトのステータス。
message	String	objects.statusオブジェクトで返されます。オブジェクトのステータスメッセージ。

GET応答の例

fetchStateジョブのステータスに対する要求が成功すると、次の例のような応答を受け取ります。

{
  "id": "7evG9CokA1whk8ehF3opKM",
  "createTime": "2018-10-26T08:15:48.502Z",
  "updateTime": "2018-10-26T08:15:48.502Z",
  "name": "fetchStateJob1",
  "startTime": "2018-10-26T08:15:48.501Z",
  "endTime": "2018-10-26T08:15:49.501Z",
  "status": {
    "state": "SUCCESSFUL",
    "message": "Export completed successfully."
  },
  "objects": null
}

要求に個々のオブジェクトのステータスが含まれていた場合、成功時の応答は次の例のようになります。

{
  "id": "7evG9CokA1whk8ehF3opKM",
  "createTime": "2017-10-26T08:15:49.000Z",
  "updateTime": "2017-10-26T08:15:50.000Z",
  "name": "fetchStateJob1",
  "startTime": "2018-10-26T08:15:49.000Z",
  "endTime": "2018-10-26T08:15:50.000Z",
  "status": {
    "state": "SUCCESSFUL",
    "message": "Export completed successfully."
  },
  "objects": [
    {
      "id": "1YmwRT083ZtfO04mUABaGF",
      "name": "Mapping1",
      "path": "/Mappings",
      "type": "DTEMPLATE",
      "description": "",
      "status": {
        "state": "SKIPPED",
        "message": null
      }
    },
    {
      "id": "46MhQv9oxrgbOD6qtosF8t",
      "name": "MappingTask1",
      "path": "/Tasks",
      "type": "MTT",
      "description": "",
      "status": {
        "state": "SUCCESSFUL",
        "message": null
      }
    },
    {
      "id": "7rM2ll1YjWYgHz4xiqRQO3",
      "name": "Default",
      "path": "/",
      "type": "Project",
      "description": "Auto-generated Default Project",
      "status": {
        "state": "SKIPPED",
        "message": null
      }
    },
    {
      "id": "8suj2pxCujqh5Vtmv0DsyP",
      "name": "Destination",
      "path": "null",
      "type": "Connection",
      "description": "Dst Connection",
      "status": {
        "state": "SKIPPED",
        "message": null
      }
    },
    {
            "id": "cpnxnIQMIYvkDOemLhFJ2q",
            "name": "03",
            "path": null,
            "type": "AgentGroup",
            "description": null,
            "status": {
                "state": "SKIPPED",
                "message": null
            }
        },
        {
            "id": "gJvuKZZuBifk9MfZFxtPAb",
            "name": "Source",
            "path": null,
            "type": "Connection",
            "description": "Src Connection",
            "status": {
                "state": "SKIPPED",
                "message": null
            }
        }
    ]
}

fetchState

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal