REST APIを使用したインポート・アクティビティのモニター方法
RESTリソースを介してインポート完了通知を受信できます。 これにより、インポート・ステータスをチェックし続ける必要がなくなります。
RESTサービスを介してインポート完了通知を受信するには、アプリケーション・コンポーザでRESTサービス・エンドポイントを定義する必要があります。 インポート・ジョブが完了するたびに通知を受け取るように、RESTエンドポイントを構成および登録できます。
アプリケーション・コンポーザでの外部RESTエンドポイントの登録
通知用のエンドポイントを登録するには:
-
にナビゲートして、サンドボックスを作成して入力します。
-
に移動します。このオプションは、サンドボックス内にいる場合にのみ使用できます。
-
「作成」アイコンをクリックして、既存のエンドポイントを編集したり、
ExternalEndPoint1
などの新しいエンドポイントを作成できます。 -
エンドポイントの名前とURLを入力し、認証スキームを選択します。 たとえば、URLはhttps://servername/ic/api/integration/v1/connections/cbveTestのような形式です。
-
POSTのチェック・ボックスをクリックすることで、POSTメソッドを選択して構成します。 現在、通知のインポート機能ではPOSTメソッドのみがサポートされています。
-
要求ペイロードおよび応答ペイロードのコード・サンプルを選択して指定します。 次に、要求ペイロードおよび応答ペイロードのサンプルを示します。
{ "items": [], "count": 0, "hasMore": false, "limit": 25, "offset": 0, "links": [{ "rel": "self", "href": "https://servername/ic/api/integration/v1/connections/cbveTest", "name": "ExternalEndPoint1", "kind": "collection" }] }
-
「保存して閉じる」をクリックします
-
変更後、サンドボックスを公開して変更をコミットします。
エンドポイントの検証
RESTエンドポイントを検証して、アプリケーション・コンポーザのwebサービスでのREST Webサービス構成が正しいこと、およびインポート・プロセスがエンドポイントを正常にコールできることを確認できます。 RESTエンドポイントを検証し、エンドポイントをデフォルトとして設定する手順は、次のとおりです。
-
にナビゲートします。
-
ここで、通知タイプとして「REST通知」を選択し、「通知エンドポイント」ドロップダウン・リストから登録したエンドポイントを選択します。 この例では、
ExternalEndPoint1
を選択します。 -
インポート・ジョブの作成時にこの接続をデフォルトとして設定するには、「既定に設定」チェック・ボックスを選択します。
-
検証するには、「ペイロード詳細」セクションをクリックし、「RESTエンドポイントの検証」ボタンをクリックします。 エンドポイントが有効な場合、「レスポンス」テキスト・ボックスに次のいずれかのレスポンス・ステータスが表示されます。
-
200
-
201
-
202
-
204
それ以外のレスポンス・ステータスは、エンドポイントが無効であることを示します。
-
インポート・アクティビティの作成およびステータスのモニター
-
にナビゲートします。
-
インポート・アクティビティを作成し、名前を入力し、オブジェクトとソース・ファイルを選択します。
-
「拡張オプション」セクションをクリックし、「通知エンドポイント」ドロップダウン・リストから通知エンドポイント
ExternalEndPoint1
を選択します。 通知を受信しない場合は、ドロップダウン・リストで空白の値を選択します。 -
「次へ」をクリックし、「フィールドのマップ」ページで属性をマップします。 構成をレビューし、ジョブを発行します。 インポート・アクティビティの作成の詳細は、データのインポートのトピックを参照してください。
-
インポートを送信したら、構成済のエンドポイントにアクセスして、ステータスを監視できます。
-
または、ログ・ファイルをダウンロードして、通知が発行されているかどうかを確認できます。 ファイルの最後のエントリは、通知のステータスを示します。
RESTおよび外部データ・ローダー・クライアントでのインポート通知(EDLC
)
EDLCコマンドlistResthooksを使用して、アプリケーション・コンポーザに登録されているリソースのリストを取得できます。 たとえば、
java -jar oscdataloader.jar listResthooks -username importuser -target-url https://mypod.oracle.com
その後、通知エンドポイントを使用して、次のコマンドを使用してインポート通知を取得できます:
java -jar oscdataloader.jar submit -input-file "AccountCSV.csv" -import-name "AccountImport" -mapping-number 30010011859 -object Account -username importuser -target-url https://mypod.oracle.com -high-volume -rest-notification "ExternalEndPoint1"
RESTを使用してインポート・アクティビティを作成する際に、RestNotification属性を使用して通知エンドポイントを指定できます。 たとえば、次のサンプル・ペイロードを使用してインポート・アクティビティを作成できます:
{
"Name": "RESTImportActivity",
"ObjectCode": "Account",
"HighVolume": "YES",
"Activate": "YES",
"RestNotification": "ExternalEndPoint1",
"DataFiles" : [
{
"InputFileContentId": "UCMFA00012159"
}
]
}
次の表に、RESTおよびEDLCでREST通知エンドポイントを指定しない場合の動作を示します。
REST通知の値 |
インポート・ジョブに使用されるエンドポイント |
REST通知の動作 |
---|---|---|
null |
デフォルト・エンドポイントが選択されます |
REST通知がデフォルトのRESTエンドポイントに送信されます。 |
REST通知が渡されていません |
デフォルト・エンドポイントが選択されます |
REST通知がデフォルトのRESTエンドポイントに送信されます。 |
"" |
RESTエンドポイントは選択されません |
REST通知は送信されません。 |