REST APIリファレンス

前へ次へ

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

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

GET要求

loadStateジョブのステータスを取得するには、次のいずれかのURIを使用します。<id>はloadStateジョブのIDです。

loadStateジョブのステータスを受け取るには、次のURIを使用します。

/public/core/v3/loadState/<id>

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

/public/core/v3/loadState/<id>?expand=objects

GET応答

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

フィールド	タイプ	説明
id	String	loadStateジョブのID。
createTime	String	オブジェクトの状態パッケージが作成された時刻。
updateTime	String	オブジェクトの状態パッケージの最終更新時刻。
name	String	loadStateジョブの名前。
startTime	String	loadStateジョブの開始時刻。
endTime	String	loadStateジョブの終了時刻。
status	複合型	パッケージのアップロードステータス。
state	String	ステータスのオブジェクトで返されます。「実行中」、「成功」、「失敗」など、loadStateジョブのステータス。
message	String	ステータスのオブジェクトで返されます。ジョブのステータスメッセージ。
sourceOrgId	String	オブジェクトの状態パッケージを作成した組織のID。
objects	コレクション	インポートに含まれるオブジェクト。
sourceObject	コレクション	objectsオブジェクトで返されます。インポートに含まれるオブジェクト。
id	String	objects.sourceObjectオブジェクトで返されます。インポートに含まれるオブジェクトのグローバル一意識別子。
name	String	objects.sourceObjectオブジェクトで返されます。インポートに含まれるオブジェクトの名前。
path	String	objects.sourceObjectオブジェクトで返されます。インポートに含まれるオブジェクトの完全なパス。
type	String	objects.sourceObjectオブジェクトで返されます。インポートに含まれるオブジェクトのタイプ。
description	String	objects.sourceObjectオブジェクトで返されます。インポートに含まれるオブジェクトの説明。
targetObject	Collection	objectsオブジェクトで返されます。ターゲットオブジェクト。
id	String	objects.targetObjectオブジェクトで返されます。ターゲットオブジェクトのグローバル一意識別子。
name	String	objects.targetObjectオブジェクトで返されます。ターゲットオブジェクトの名前。
path	String	objects.targetObjectオブジェクトで返されます。ターゲットオブジェクトの完全なパス。
type	String	objects.targetObjectオブジェクトで返されます。ターゲットオブジェクトのタイプ
description	String	objects.targetObjectオブジェクトで返されます。ターゲットオブジェクトの説明。
status	String	objects.targetObjectオブジェクトで返されます。ターゲットオブジェクトのステータス。
status	複合型	objectsオブジェクトで返されます。オブジェクトのロードステータス。
state	String	objects.statusオブジェクトで返されます。「実行中」、「成功」、「失敗」など、オブジェクトのロード状態。
message	String	objects.statusオブジェクトで返されます。オブジェクトのステータスメッセージ。
checksumValid	Boolean	objects.statusオブジェクトで返されます。オブジェクトのチェックサムが有効だったかどうか。

GET応答の例

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

{
  "id": "2oZb7vFI2QQg4ncd4AyCGn",
  "createTime": "2017-10-26T08:40:09.000Z",
  "updateTime": "2017-10-26T08:55:56.000Z",
  "name": "stateImportJob",
  "startTime": "2017-10-26T08:55:53.000Z",
  "endTime": "2017-10-26T08:55:56.000Z",
  "status": {
    "state": "SUCCESSFUL",
    "message": "Import completed successfully."
  },
  "objects": null,
  "sourceOrgId": "2wy21a5fkUphzTVNKaPowg",
  "checksumValid": true
}

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

{
    "id": "3OpbyDU36UgkUhXXtvGsYA",
    "createTime": "2019-01-10T21:35:33.000Z",
    "updateTime": "2019-01-10T21:35:39.000Z",
    "name": "job-1547156138681",
    "startTime": "2019-01-10T21:35:39.000Z",
    "endTime": "2019-01-10T21:35:39.000Z",
    "status": {
        "state": "SUCCESSFUL",
        "message": "Import completed successfully."
    },
    "objects": [
        {
            "sourceObject": {
                "id": "46MhQv9oxrgbOD6qtosF8t",
                "name": "MappingTask",
                "path": "/Default",
                "type": "MTT",
                "description": ""
            },
            "targetObject": {
                "id": null,
                "name": "MappingTask",
                "path": "/Default",
                "type": "MTT",
                "description": null,
                "status": null
            },
            "status": {
                "state": "SUCCESSFUL",
                "message": "Overwrite existing."
            }
        }
    ],
    "sourceOrgId": "2wy21a5fkUphzTVNKaPowg",
    "checksumValid": true
}

loadState

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal