1. Sales and Fusion Service向け顧客データ管理の使用
  2. REST APIを使用したエクスポート・アクティビティのモニター方法
機械翻訳について

REST APIを使用したエクスポート・アクティビティのモニター方法

このトピックでは、RESTリソースを介して完了通知を受信する方法と、エクスポート・ステータスを常に確認しなくても済む方法について説明します。

RESTサービスを介してエクスポート完了通知を受信するには、アプリケーション・コンポーザでRESTサービス・エンドポイントを定義する必要があります。 エクスポート・ジョブの完了時に通知を受信するようにRESTエンドポイントを構成および登録できます。

アプリケーション・コンポーザでの外部RESTエンドポイントの登録

通知用のエンドポイントを登録するには:

  1. 「構成」→「サンドボックス」→「サンドボックスの作成」にナビゲートして、サンドボックスを作成して入力します。

  2. 「構成」→「アプリケーション・コンポーザ」→「Webサービス」に移動します。 このオプションは、サンドボックス内にいる場合にのみ使用できます。

  3. 「作成」アイコンをクリックして、既存のエンドポイントを編集したり、ExternalEndPoint1などの新しいエンドポイントを作成できます。

  4. エンドポイントの名前とURLを入力し、認証スキームを選択します。 たとえば、URLはhttps://servername/ic/api/integration/v1/connections/cbveTestのような形式です。

  5. POSTのチェック・ボックスをクリックすることで、POSTメソッドを選択して構成します。 現在、エクスポート通知機能ではPOSTメソッドのみがサポートされています。

  6. 要求ペイロードおよび応答ペイロードのコード・サンプルを選択して指定します。 次に、要求ペイロードおよび応答ペイロードのサンプルを示します。 

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

  7. 「保存してクローズ」をクリックします。

  8. 変更後、サンドボックスを公開して変更をコミットします。

エンドポイントの検証

RESTエンドポイントを検証して、アプリケーション・コンポーザのWebサービスでのREST Webサービス構成が正しく、エクスポート・プロセスでエンドポイントを正常にコールできることを確認できます。 RESTエンドポイントを検証し、エンドポイントをデフォルトとして設定する手順は、次のとおりです。

  1. 「ツール」→「エクスポート管理」→「構成のエクスポート」→「REST通知」にナビゲートします。

  2. ここで、通知タイプとして「REST通知」を選択し、「通知エンドポイント」ドロップダウン・リストから登録したエンドポイントを選択します。 この例では、ExternalEndPoint1を選択します。

  3. エクスポート・ジョブの作成時にこの接続をデフォルトとして設定するには、「デフォルトとして設定」チェック・ボックスを選択します。

  4. 検証するには、「ペイロード詳細」セクションをクリックし、「RESTエンドポイントの検証」ボタンをクリックします。 エンドポイントが有効な場合、「レスポンス」テキスト・ボックスに次のいずれかのレスポンス・ステータスが表示されます。

    • 200

    • 201

    • 202

    • 204

    それ以外のレスポンス・ステータスは、エンドポイントが無効であることを示します。

エクスポート・アクティビティの作成およびステータスのモニター

  1. 「ツール」→「エクスポート管理」→「エクスポート・アクティビティの作成」にナビゲートします。

  2. エクスポート・アクティビティを作成し、名前を入力して、エクスポートするオブジェクトを選択します。

  3. 「拡張オプション」セクションをクリックし、「通知エンドポイント」ドロップダウン・リストから通知エンドポイントExternalEndPoint1を選択します。 通知を受信しない場合は、ドロップダウン・リストで空白の値を選択します。

  4. 「次」をクリックし、「フィールドのマップ」ページでエクスポートする属性を選択します。 少なくとも最上位オブジェクト用のフィルタを作成し、「次」をクリックします。 エクスポート・アクティビティの作成の詳細は、「データのエクスポート」のトピックを参照してください。

  5. エクスポート構成を確認し、エクスポート・ジョブを発行します。 エクスポートを発行したら、構成済のエンドポイントにアクセスして、ステータスを監視できます。

  6. または、ログ・ファイルをダウンロードして、通知が発行されているかどうかを確認できます。 ファイルの最後のエントリは、通知のステータスを示します。

RESTでのエクスポート通知

RestNotification属性を使用して、RESTを使用したエクスポート・アクティビティの作成時に通知エンドポイントを指定できます。 たとえば、次のサンプル・ペイロードを使用してエクスポート・アクティビティを作成できます。 

{
    "Name": "Account_Export",
    "ExportObject": "Account",
    "ExportFilterCriteria": "OrganizationName IS NOT NULL",
    "ExportFileName": "Account.zip",
    "Activate": "YES",
    "RestNotification": "ExternalEndPoint1"
}}

次の表では、REST通知エンドポイントを指定しない場合の動作について説明します。

REST通知の値

エクスポート・ジョブに使用されるエンドポイント

REST通知の動作

null

デフォルト・エンドポイントが選択されます

REST通知はデフォルトのRESTエンドポイントに送信されます。

REST通知が渡されていません

デフォルト・エンドポイントが選択されます

REST通知はデフォルトのRESTエンドポイントに送信されます。

""

RESTエンドポイントは選択されません

REST通知は送信されません。

関連トピック