REST APIリファレンス

前へ次へ

インポートジョブのステータスの取得

GET要求を使用して、インポートジョブのステータスを取得するか、インポートジョブのログをダウンロードします。

GET要求

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

インポートジョブのステータスを受け取るには、次のいずれかのURIを使用します。

/public/core/v3/import/<id>

インポートジョブ内の各オブジェクトのステータスを受け取るには、次のいずれかのURIを使用します。

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

インポートジョブのログをダウンロードするには、次のURIを使用します。

/public/core/v3/import/<id>/log

GET応答

インポートジョブのログを要求すると、ログがテキストファイルで返されます。

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

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

GET応答の例

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

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

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

{
  "id": "2oZb7vFI2QQg4ncd4AyCGn",
  "createTime": "2017-10-26T08:40:09.000Z",
  "updateTime": "2017-10-26T08:55:56.000Z",
  "name": "ImportName",
  "startTime": "2017-10-26T08:55:53.000Z",
  "endTime": "2017-10-26T08:55:56.000Z",
  "status": {
    "state": "SUCCESSFUL",
    "message": "Import completed successfully."
  },
  "objects": [
    {
      "sourceObject": {
        "id": "ejZY66c19YUccBdbGwKG4P",
        "name": "M1",
        "path": "/Default",
        "type": "MAPPING",
        "description": "ab"
      },
      "targetObject": {
        "id": null,
        "name": "M1",
        "path": "/default1",
        "type": "MAPPING",
        "description": null,
        "status": null
      },
      "status": {
        "state": "SUCCESSFUL",
        "message": "Reuse existing."
      }
    },
    {
      "sourceObject": {
        "id": "iIVBNZSpUKFg4N6g2PKUox",
        "name": "abc_map",
        "path": "/Default",
        "type": "MAPPING",
        "description": ""
      },
      "targetObject": {
        "id": null,
        "name": "abc_map",
        "path": "/default1",
        "type": "MAPPING",
        "description": null,
        "status": null
      },
      "status": {
        "state": "SUCCESSFUL",
        "message": "Overwrite existing."
      }
    }
  ],
  "sourceOrgId": "0VOx1gScNH7dlDyA4tD8yX"
}

インポートジョブのログを要求した場合、返されるテキストファイルの内容は次の例のようになります。

> OIE_002 INFO 2019-02-07T01:02:24.986Z Starting import operation.
Execution Client: API
Job Name: ImportExportMapping2-1541009746833
Organization: infa.doc
RequestId: 68srkYNhdSkdKCKfLBGxyd
User: janer2
> OIE_006 INFO 2019-02-07T01:02:25.416Z Successfully imported object [/Explore/ImportExport] of type [Project] id [3z0FL8tjqEbizNwVBV9LWR] to [/Explore/ImportExport]
> OIE_006 INFO 2019-02-07T01:02:25.931Z Successfully imported object [/SYS/CustFF] of type [SAAS_CONNECTION] id [76c7oud5pBzlyAC3tdfVK2] to [/SYS/CustFF]
> OIE_006 INFO 2019-02-07T01:02:26.598Z Successfully imported object [/Explore/ImportExport/ImportExportMapping2] of type [MAPPING] id [09wsnChCzUYl9OWCy6PKIe] to [/Explore/ImportExport/ImportExportMapping2]
> OIE_003 INFO 2019-02-07T01:02:26.598Z Finished import operation.
Job Name: ImportExportMapping2-1541009746833
Start Time: 2019-02-07T01:02:24.915Z
End Time: 2019-02-07T01:02:26.598Z
Started by: janer2
Start Method: API
Source Organization: infadoc2
Status: SUCCESSFUL

オブジェクトのインポート

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal