REST APIリファレンス

前へ次へ

エクスポートジョブのステータスの取得

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

GET要求

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

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

/public/core/v3/export/<id>

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

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

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

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

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

GET応答

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

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

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

GET応答の例

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

{
  "id": "7evG9CokA1whk8ehF3opKM",
  "createTime": "2017-10-26T08:15:48.502Z",
  "updateTime": "2017-10-26T08:15:48.502Z",
  "name": "testJob1",
  "startTime": "2017-10-26T08:15:48.501Z",
  "endTime": null,
  "status": {
    "state": "IN_PROGRESS",
    "message": "In Progress."
  },
  "objects": null
}

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

{
  "id": "7evG9CokA1whk8ehF3opKM",
  "createTime": "2017-10-26T08:15:49.000Z",
  "updateTime": "2017-10-26T08:15:50.000Z",
  "name": "testJob1",
  "startTime": "2017-10-26T08:15:49.000Z",
  "endTime": "2017-10-26T08:15:50.000Z",
  "status": {
    "state": "SUCCESSFUL",
    "message": "Export completed successfully."
  },
  "objects": [
    {
      "id": "1MW0GDAE1sFgnvWkvom7mK",
      "name": "Linear Taskflow",
      "path": "/ICS Taskflow",
      "type": "SAAS_LINEAR_TASKFLOW",
      "description": null,
      "status": {
        "state": "SUCCESSFUL",
        "message": null
      }
    },
    {
      "id": "1SuZ9Gf8LtphrJn9EdHCod",
      "name": "SQL Server",
      "path": "/DSS",
      "type": "Folder",
      "description": "",
      "status": {
        "state": "SUCCESSFUL",
        "message": null
      }
    },
    {
      "id": "1Uf9PTj6kTjbsVYMk55OC6",
      "name": "Synchronization Task Multi Source",
      "path": "/Default/SQL Server",
      "type": "SAAS_DSS",
      "description": "",
      "status": {
        "state": "SUCCESSFUL",
        "message": null
      }
    },
    {
      "id": "2UL9ZO9Z3OJeuxbL2cYbaX",
      "name": "Synchronization Task Simple Filter",
      "path": "/Default/SQL Server",
      "type": "SAAS_DSS",
      "description": "",
      "status": {
        "state": "SUCCESSFUL",
        "message": null
      }
    },
    {
      "id": "31SzqpeEEKacy7OaXXCfaD",
      "name": "Synchronization Task Multi Source",
      "path": "/DSS/SQL Server",
      "type": "SAAS_DSS",
      "description": "",
      "status": {
        "state": "SUCCESSFUL",
        "message": null
      }
    },
    {
      "id": "5FA0DnMzeuDbYZnn3hdto9",
      "name": "Default",
      "path": "/",
      "type": "Project",
      "description": "Auto-generated Default Project",
      "status": {
        "state": "SUCCESSFUL",
        "message": null
      }
    },
    {
      "id": "5V5VpaoJGTNkWCB2f2t4MG",
      "name": "Synchronization Task Simple Filter",
      "path": "/DSS/SQL Server",
      "type": "SAAS_DSS",
      "description": "",
      "status": {
        "state": "SUCCESSFUL",
        "message": null
      }
    },
    {
      "id": "7udJJF48H5Iizzry8gjUAb",
      "name": "SQL Server",
      "path": "/Default",
      "type": "Folder",
      "description": "",
      "status": {
        "state": "SUCCESSFUL",
        "message": null
      }
    },
    {
      "id": "fIQLvhNnsqBjXKNfjyZFaH",
      "name": "ICS Taskflow",
      "path": "/",
      "type": "Project",
      "description": "",
      "status": {
        "state": "SUCCESSFUL",
        "message": null
      }
    },
    {
      "id": "hGrgtrajWMUjNIsnLKQCAi",
      "name": "SQL Server Linux",
      "path": null,
      "type": "SAAS_CONNECTION",
      "description": null,
      "status": {
        "state": "SUCCESSFUL",
        "message": null
      }
    },
    {
      "id": "iIVBNZSpUKFg4N6g2PKUox",
      "name": "abc_map",
      "path": "/Default",
      "type": "MAPPING",
      "description": "",
      "status": {
        "state": "SUCCESSFUL",
        "message": null
      }
    },
    {
      "id": "l7bgB85m5oGiXObDxwnvK9",
      "name": "DSS",
      "path": "/",
      "type": "Project",
      "description": "",
      "status": {
        "state": "SUCCESSFUL",
        "message": null
      }
    },
    {
      "id": "lOqsFQE4OSWeyg77AeWwK2",
      "name": "Linux",
      "path": null,
      "type": "SAAS_RUNTIME_ENVIRONMENT",
      "description": null,
      "status": {
        "state": "SUCCESSFUL",
        "message": null
      }
    }
  ]
}

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

> OIE_002 INFO 2019-02-05T22:50:08.788Z Starting export operation.
Execution Client: API
Job Name: m_RegionTotalNew-1549407002393
Organization: infa2.doc
RequestId: iklHoZTokKAiNO95Cw9NG3
User: janer2
> OIE_004 INFO 2019-02-05T22:50:09.042Z Successfully exported object [/SYS/_SYSTEM_PROJECT] of type [Project] id [5UrdDrgV5yKerYgtJAA4IU]> OIE_004 INFO 2019-02-05T22:50:09.042Z Successfully exported object [/Explore/Accounts] of type [Project] id [8Uyq1wiZ9lye2Sou5OCqOa]
> OIE_004 INFO 2019-02-05T22:50:09.126Z Successfully exported object [/SYS/_SYSTEM_FOLDER] of type [Folder] id [b98UuC0ADGEkXxF9EIlUCZ]
> OIE_004 INFO 2019-02-05T22:50:09.126Z Successfully exported object [/Explore/Accounts/February2018] of type [Folder] id [cojSZpHcqcafFy6YkCBgIl]
> OIE_004 INFO 2019-02-05T22:50:09.354Z Successfully exported object [/SYS/TMS26W0864] of type [SAAS_RUNTIME_ENVIRONMENT] id [6TKTNZ3wfIIjV5yBTJmYWO]
> OIE_004 INFO 2019-02-05T22:50:09.504Z Successfully exported object [/SYS/ff] of type [SAAS_CONNECTION] id [7GgahDJzE9GbYb75xQ35GM]
> OIE_004 INFO 2019-02-05T22:50:09.765Z Successfully exported object [/Explore/Accounts/February2018/m_RegionTotalNew] of type [MAPPING] id [4LiKwGKgegAixI2awqWgK1]
> OIE_003 INFO 2019-02-05T22:50:09.843Z Finished export operation.
Job Name: m_RegionTotalNew-1549407002393
Start Time: 2019-02-05T22:50:03.000Z
End Time: 2019-02-05T22:50:09.765Z
Started by: janer2
Start Method: API 
Source Organization: infa.doc
Status: SUCCESSFUL

オブジェクトのエクスポート

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal