1. アプリケーション・ビルダー・ユーザーズ・ガイド
  2. アプリケーション・データの管理
  3. RESTデータ・ソースの管理
  4. Oracle Cloud Applications BOSS REST Serviceに関する操作
  5. BOSS RESTデータ・ソースの作成

18.4.8.2 BOSS RESTデータ・ソースの作成

BOSS RESTデータ・ソースの作成について学習します。

BOSS RESTデータ・ソースを作成するには、「RESTデータ・ソースの作成」ウィザードを実行します。プロンプトが表示されたら、RESTデータ・ソース・タイプ「Oracle Cloud Applications (BOSS) REST Service」を選択します。このトピックでは、RESTデータ・ソースの作成ウィザードを実行する際の主な決定ポイントについて説明します。

ヒント:

ウィザードのすべてのオプションの詳細は、アイテム・ヘルプ、または「RESTデータ・ソースの作成」の一般的な説明を参照してください。

RESTデータ・ソースを作成するには:

  1. 「RESTデータ・ソース」ページにナビゲートします。
    1. ワークスペースのホームページで、「アプリケーション・ビルダー」をクリックします。
    2. アプリケーションを選択します。
    3. アプリケーションのホームページで、「共有コンポーネント」をクリックします。
    4. 「データ・ソース」で、「RESTデータ・ソース」を選択します。
  2. 「RESTデータ・ソース」ページで、「作成」をクリックします。
    RESTデータ・ソースの作成ウィザードが表示されます。
  3. RESTデータ・ソースの作成 - 「最初から」を選択し、「次」をクリックします。
  4. 一般:
    1. RESTデータ・ソース・タイプ - 「Oracle Cloud Applications (BOSS) REST Service」を選択します。
    2. 名前 - このRESTデータ・ソースのわかりやすい名前を入力します。
    3. URLエンドポイント - RESTデータ・ソースのエンドポイントURLを入力します(http://またはhttps://で始めます)。
    4. 「次」をクリックします。
  5. リモート・サーバー - デフォルトを受け入れます。

    このステップでは、APEXが「ベースURL」と「サービスURLパス」の組合せとしてREST APIのエンドポイントURLを管理する方法を示します。

  6. 設定:
    1. 参照の検出 - データ・プロファイルの検出時と再検出時にBOSSエンドポイントについてのその他の読取り専用情報として第1レベルの参照オブジェクトも含めるには、「はい」を設定します。「いいえ」に設定した場合は、APEXに、エンドポイントのルート・ビジネス・オブジェクト属性のみが含まれます。初期RESTデータ・ソースを作成した後に、データ・プロファイルを編集することで、必要に応じて他のものを含めることができます。
    2. バルクDMLの使用 - バルクDMLを使用すると、このRESTサービスに対する複数の削除、更新および挿入操作がグループ化されてリモート・サーバーと1回で交換されることで、パフォーマンスが向上します。バルクDMLの使用中に特定のBOSSサービス・エンドポイントで機能上の問題が発生した場合のみ、この設定を無効にすることをお薦めします。
    3. 合計結果の使用 - Oracle Cloud Applications (BOSS) REST Serviceでは、一部のみが返された場合(最初のページなど)でも、結果の合計数を返すことができます。状況によっては、この行合計数計算により、不要な実行時オーバーヘッドが生じることがあります。この値を「いいえ」に設定すると、APEXでこのデータ・ソースに対してこの機能が使用されないようにすることができます。
    4. ページ区切りの使用 - 一般に、Oracle Cloud Applications (BOSS) RESTサービスでは、一度に1ページの結果の取得がサポートされています。ただし、このデータ・ソースのエンドポイントで"$offset"パラメータがサポートされていない場合、このプロパティを「いいえ」に設定するとページ区切りが無効になります。
    5. 「次」をクリックします。
  7. 「認証」、「認証が必要です」 - 新しいRESTデータ・ソースに認証が必要となるかどうかを選択します。有効にした場合は、「資格証明」と「認証タイプ」を指定します。
  8. 続行するには、次のいずれかを選択します。
    • 詳細 - データ・プロファイルの詳細パラメータを表示します。検出に必要になる可能性がある名前付きパラメータをさらに追加するには、「詳細」を使用します。
    • 検出 - 検出モードを開始します。APEXで、外部のWebサービスに関する情報を取得するために、複数のHTTPリクエストが実行されます。これらの複数のHTTPリクエストの1つは、Webサービスに関するOpenAPI情報を取得するHTTPリクエストです。APEXで、Webサービスによって返されたデータ(JSONまたはXML)のサンプルを取得し、データ・プロファイル(JSON属性に関するメタデータで構成される)を導出します。その後、検出結果が表示され、RESTデータ・ソースを作成するかどうかが確認されます。
  9. 「詳細」をクリックすると、パラメータ・ページが表示されます。
    パラメータ・ページを使用して、検出で必要になる可能性がある初期RESTデータ・ソース・パラメータを構成します。一部のRESTデータ・ソースでは、特定のHTTPヘッダー(User-Agentなど)の設定が必要になる場合があります。詳細パラメータを設定した後、「検出」をクリックします。
  10. 「検出」をクリックすると、APEXによってRESTサービスURLが呼び出され、プレビューが表示されます。のAPEXによって、JSONレスポンスから、BOSSエンドポイントのOpenAPI記述も取得されます。これは、データ・プロファイルを作成するための、属性、データ型および追加情報注釈の導出に使用されます。

    表示される情報は、BOSSエンドポイントのデフォルト・ビューで構成されている属性によって異なります。デフォルト・ビューに含まれていない属性はこのプレビューの間にNULLとして表示されると想定されています。「データ」タブには、サンプル・レスポンス・データがレポート形式で表示されます。

    「データ・プロファイル」タブには、APEXによって検出中に見つかったデータ・プロファイル列について情報が表示されます。このタブを使用して、列の名前とデータ型を確認します。

    名前付き列を削除する場合は、[TAB]キーを使用して削除する列に移動し、[Enter]キーを押すか、単にマウスを使用してXアイコンを押します。

    「レスポンス本文」タブには、APEXが検出中に発見したレスポンス本文構造に関する情報が表示されます。

    「詳細」をクリックして、レスポンス本文、レスポンス・ヘッダー、RESTデータ・ソース操作など、RESTデータ・ソースのレスポンスに関する追加の詳細情報を表示します。

  11. 「RESTデータ・ソースの作成」をクリックします。
    RESTデータ・ソースが作成されます。

親トピック: Oracle Cloud Applications BOSS REST Serviceに関する操作