REST APIリファレンス

前へ次へ

インポートジョブの開始

POST要求を使用して、インポートジョブを指定して開始します。アセット、接続、Secure Agentの設定、スケジュールなどのオブジェクトをインポートできます。

POST要求

要求には、インポートするオブジェクトのリストと、発生する可能性のある競合を解決するためのパラメータを含めます。競合の解決の例としては、ターゲット組織にある別のアセットと同じ名前を持つアセットをインポートしようとする場合が挙げられます。

コネクタのタイプとバージョンが同じであれば、ターゲット組織に存在するランタイム環境をソースランタイム環境の代わりに使用するように指定できます。ターゲット組織のランタイム環境のリストを検索するには、ルックアップリソースを使用します。

インポートオブジェクトを指定し、インポートジョブを開始するには、次のURIを使用します。

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

<id>は、インポートパッケージのアップロードのPOST応答で受信されるインポートジョブIDです。

要求に含めるオブジェクトIDを取得するには、ルックアップリソースを使用します。詳細については、ルックアップを参照してください。

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

フィールド	タイプ	必須	説明
name	String	○	インポートジョブの名前。デフォルトの名前はjob-<currentTimeInMilliseconds>です。
importSpecification	複合型	-	インポート仕様を指定するために使用します。指定しない場合、インポートパッケージ内のすべてのオブジェクトがインポートに含まれ、デフォルトの競合解決設定が使用されます。
defaultConflictResolution	String	-	importSpecificationオブジェクトに含まれます。既存のオブジェクトをインポートファイル内のすべてのオブジェクトで上書きするかどうかを示します。以下のオプションが含まれます。 OVERWRITE。既存のオブジェクトをインポートファイルのオブジェクトで上書きします。アセットに対するデフォルト値です。 REUSE。既存のオブジェクトを使用します。オブジェクトが存在しない場合は作成されます。接続、ランタイム環境、プロジェクト、フォルダ、およびスケジュールに対するデフォルト値です。
includeObjects	Collection<String>	-	importSpecificationオブジェクトに含まれます。インポートに含めるオブジェクト。lookupリソースを使用して、オブジェクトIDを検索できます。指定しない場合、インポートパッケージ内のすべてのオブジェクトがインポートに含まれます。指定したオブジェクトがプロジェクトの場合、そのプロジェクトに属するすべてのアセットと、ターゲット組織にまだ存在しないすべての依存オブジェクトがインポートに含まれます。指定されたオブジェクトがアセットの場合、アセットのコンテナ（プロジェクト、フォルダ）が存在しないときはインポートによってこれらが作成されます。 1つのインポートジョブに含めるオブジェクトは1000個以内にすることをお勧めします。
objectSpecification	Collection<複合型>	-	importSpecificationオブジェクトに含まれます。オブジェクトのプロパティを指定します。プロパティが特定のオブジェクトに対して指定されていない場合、インポートではデフォルトの競合の解決設定を使用します。
conflictResolution	String	-	objectSpecificationオブジェクトに含まれます。既存のアセットをインポートファイルのアセットで上書きするかどうかを示します。以下のオプションが含まれます。 OVERWRITE。既存のアセットをインポートファイルのアセットで上書きします。 REUSE。既存のオブジェクトを使用します。オブジェクトが存在しない場合は作成されます。データ統合マッピングタスク、アプリケーション統合ガイド、B2B Gatewayサプライヤ、Data Quality ディクショナリなどのアセットに適用できます。プロジェクト、フォルダ、ランタイム環境、または接続には使用しないでください。ターゲット組織に存在しない場合、インポートには、アセットに関連付けられた接続およびランタイム環境が含まれます。
sourceObjectId	String	○	objectSpecificationオブジェクトに含まれます。エクスポートパッケージファイルのオブジェクトID。 objectSpecificationが存在する場合は必須です。
targetObjectId	String	-	objectSpecificationオブジェクトに含まれます。コンテナ間マッピング、および一部のアセット間マッピングに使用されます。ターゲット組織内に存在する接続またはランタイム環境を指定するために使用します。ターゲットオブジェクトで使用するコネクタのタイプとバージョンは、ソースオブジェクトで使用されているものと同じである必要があります。
additionalProviderFlags	Collection<複合型>	-	追加のオブジェクト指定。キーと値のペアを使用して、入出力パラメータ値やシーケンスジェネレータ値などの追加のオブジェクト指定を指定します。

POST要求の例

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

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

{
    "name": "ImportName",
    "importSpecification": {
        "defaultConflictResolution": "REUSE",
        "includeObjects": ["iIVBNZSpUKFg4N6g2PKUox","ejZY66c19YUccBdbGwKG4P"],
        "objectSpecification": [
           {
            "sourceObjectId": "iIVBNZSpUKFg4N6g2PKUox",
            "conflictResolution": "OVERWRITE"
           },
           {
            "sourceObjectId": "5FA0DnMzeuDbYZnn3hdto9",
            "targetObjectId": "5KgUiEkW95NkjLRRefWKiG"
            "additionalProviderFlags": [
              {
               "key": "Sequence",
               "value": "26908"
              }
            ]
          }
        ]
    }
}

POST応答

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

フィールド	タイプ	説明
jobId	String	インポートジョブのID。
createTime	String	インポートジョブが作成された時刻。
updateTime	String	インポートジョブの最終更新時刻。
name	String	インポートジョブの名前。
startTime	String	インポートジョブの開始時刻。
endTime	String	インポートジョブの終了時刻。
status	Collection	パッケージのアップロードステータス。
state	String	ステータスのオブジェクトで返されます。「実行中」、「成功」、「失敗」など個々のオブジェクトのインポート状態。
message	String	ステータスのオブジェクトで返されます。インポートジョブのステータスメッセージ。
objects	Collection	インポートジョブに含まれるオブジェクト。
sourceOrgId	String	インポートされたエクスポートパッケージを作成した組織の組織ID。

POST応答の例

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

{
  "id": "2oZb7vFI2QQg4ncd4AyCGn",
  "createTime": "2024-02-26T08:40:09.000Z",
  "updateTime": "2024-02-26T08:55:53.238Z",
  "name": "ImportName",
  "startTime": "2024-02-26T08:55:53.232Z",
  "endTime": "2024-02-26T08:53:03.000Z",
  "status": {
    "state": "IN_PROGRESS",
    "message": "In Progress."
  },
  "objects": null,
  "sourceOrgId": "0VOx1gScNH7dlDyA4tD8yX"
}

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

{
  "error": {
    "code": "MigrationSvc_040",
    "message": "User does not have required permissions.",
    "requestId": "2ataXVlgw3ydI1Yb2MA4sq"
  }
}

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

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal