REST APIリファレンス > プラットフォームREST APIバージョン3リソース > オブジェクトのエクスポート

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

このリソースとインポートリソースを一緒に使用して、オブジェクトを1つの組織から別の組織へと移行します。

オブジェクトのエクスポートには、一連の要求および応答が含まれます。最終的な結果はエクスポートされたオブジェクトを含むZIPファイルとなります。オブジェクトをエクスポートするには、次のタスクを実行します。

1ソース組織にログインします。
2クエリパラメータを含むオブジェクトGET要求を送信して、エクスポートするオブジェクトのリストを取得します。エクスポートするオブジェクトが分かっている場合は、ルックアップGET要求を送信してそのオブジェクトのオブジェクトIDを取得します。

Informatica Intelligent Cloud ServicesによりオブジェクトIDが返されます。

オブジェクトおよびルックアップを参照してください。

3objectsまたはlookupの応答で返されたオブジェクトIDを使用してexport POST要求を送信して、exportジョブを開始します。

Informatica Intelligent Cloud Servicesで、エクスポートジョブのジョブIDを返します。

エクスポートジョブの開始を参照してください。

4エクスポートGET要求を送信し、エクスポートパッケージのエクスポートジョブIDを使用してエクスポートジョブのステータスを取得します。

Informatica Intelligent Cloud Servicesで、ジョブIDとステータスを返します。応答には、エクスポートパッケージ内のオブジェクトのリストも含めることができます。

エクスポートジョブのステータスの取得を参照してください。

5エクスポートGET要求を送信して、エクスポートパッケージをダウンロードします。

Informatica Intelligent Cloud ServicesからエクスポートパッケージがZIPファイル形式で返されます。

エクスポートパッケージのダウンロードを参照してください。

注: このリソースは、動的レート制限を使用します。システムで大量の要求またはサイズが発生すると、応答が遅くなったり、「要求が多すぎます」というエラーメッセージが表示されて失敗したりすることがあります。

エクスポートジョブの開始

POST要求を使用してエクスポートジョブを開始します。

POST要求

アセット、接続、Secure Agentの設定、スケジュールなどのオブジェクトをエクスポートできます。エクスポートするオブジェクトを指定してエクスポートジョブを開始するには、次のURIを使用します。

/public/core/v3/export

要求に次のフィールドを含めます。

フィールド	タイプ	必須	説明
name	String		エクスポートジョブの名前。名前を指定しない場合、次の形式のデフォルト名が使用されます: job-<currentTimeInMilliseconds>
objects	Collection<複合型>	はい	エクスポートするオブジェクトのオブジェクトID。注: 1つのエクスポートファイルに含めるオブジェクトは1000個以内にすることをお勧めします。
id	String	○	objectsオブジェクトに含まれます。エクスポートオブジェクトのグローバル一意識別子。これは、プロジェクト、フォルダ、またはアセットのIDです。
includeDependencies	Boolean		objectsオブジェクトに含まれます。アセットの依存オブジェクトをエクスポートに含めるかどうかを決定します。デフォルトはTrueです。

アセットにタグが含まれている場合は、アセットのエクスポート時にタグをエクスポートできます。アセットタグをエクスポートするには、POST要求にincludeTagInformation要求パラメータを含めます。

次のURIを使用します。

/public/core/v3/export?includeTagInformation =true

POST要求の例

次の例のような要求を使用できます。

POST <baseApiUrl>/public/core/v3/export
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>

{
"name" : "testJob1",
"objects" : [
{
"id": "l7bgB85m5oGiXObDxwnvK9",
"includeDependencies" : true
},
{
"id": "1MW0GDAE1sFgnvWkvom7mK",
"includeDependencies" : false
},
{
"id": "iIVBNZSpUKFg4N6g2PKUox"
}
]
}

POST応答

成功した場合、エクスポートジョブの次の情報が返されます。

フィールド	タイプ	説明
id	String	エクスポートジョブのID。
createTime	String	エクスポートパッケージが作成された時間。
updateTime	String	エクスポートパッケージが最後に更新された時間。
name	String	インポートジョブの名前。
startTime	String	エクスポートジョブが開始された時間。
endTime	String	エクスポートジョブが終了した時間。
status	複合型	エクスポートのステータス。
state	String	ステータスのオブジェクトで返されます。エクスポートジョブのステータス（例: 実行中、成功、失敗）。
message	String	ステータスのオブジェクトで返されます。エクスポートジョブのステータスメッセージ。
objects	Collection	オブジェクトのコレクション。空白の場合、NULLを返します。

POST応答の例

成功した場合、次の例のような応答を受信します。

{
"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
}

エラーを受信した場合、次の例のような応答が表示されます。

{
"error": {
"code": "MigrationSvc_034",
"message": "Invalid object id/s [[242973wgfscbwasd23]]. Object resolution failed.",
"requestId": "2ataXVlgw3ydI1Yb2MA4sq"
}
}

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

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: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

エクスポートパッケージのダウンロード

GET要求を使用して、エクスポートパッケージをダウンロードします。

GET要求

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

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

<id>はエクスポートジョブのIDです。

GET応答

正常に完了すると、応答タイプapplication/zipのZIPストリームを応答本文で受け取ります。

失敗すると、次の例のような応答を受け取ります。

{
"error": {
"code": "MigrationSvc_017",
"message": "Export request with identifier [asdasduguyvasd8347] doesn't exist.",
"requestId": "2ataXVlgw3ydI1Yb2MA4sq"
}
}