1. アプリケーション・ビルダー・ユーザーズ・ガイド
  2. アプリケーション・データの管理
  3. RESTデータ・ソースの管理
  4. RESTデータ・ソースの編集または削除

18.4.4 RESTデータ・ソースの編集または削除

共有コンポーネントからRESTデータ・ソースを編集または削除します。

親トピック: RESTデータ・ソースの管理

18.4.4.1 RESTデータ・ソースの編集

「共有コンポーネント」からRESTデータ・ソースを編集します。

RESTデータ・ソースを編集するには:

  1. 「RESTデータ・ソース」ページにナビゲートします。
    1. ワークスペースのホームページで、「アプリケーション・ビルダー」をクリックします。
    2. アプリケーションを選択します。
    3. アプリケーションのホームページで、ページの中央にある「共有コンポーネント」をクリックします。
    4. 「データ・ソース」で、「RESTデータ・ソース」を選択します。
  2. 「RESTデータ・ソース」ページで、「RESTソース名」をクリックします。
    「RESTデータ・ソース」ページが表示されます。
  3. 「RESTデータ・ソース」属性を編集します。
  4. 「RESTデータ・ソース」で、次の項目を指定します。
    1. 名前 - このRESTデータ・ソースのわかりやすい名前を定義します。
    2. RESTデータ・ソース・タイプ - RESTデータ・ソース・タイプ(組込みタイプまたはRESTソース・プラグインで定義されたタイプ)を選択します。詳しい説明は、アイテム・ヘルプで詳細を確認するか、「RESTデータ・ソース・タイプについて」を参照してください。

      「RESTデータ・ソース・タイプ」に応じて、この後に表示される内容が決まります。この例では、「RESTデータ・ソース・タイプ」が「簡易HTTP」に設定されています。

    3. リモート・サーバー - このRESTデータ・ソースのリモート・サーバー・オブジェクトを選択します。さらに学習するには、フィールドレベル・ヘルプを参照してください。
    4. ベースURL - ベースURLが表示されます。
    5. URLパス接頭辞 - URLパス接頭辞は、このRESTデータ・ソースに固有です。RESTデータ・ソース内のすべての操作のURLエンドポイントは、同じURLパス接頭辞を共有します。さらに学習するには、フィールドレベル・ヘルプを参照してください。
  5. 「RESTデータ・ソース・タイプ」が「簡易HTTP」の場合、「設定」で「ページ区切りタイプ」を選択します:
    • ページ区切りなし

    • ページ・サイズとフェッチ・オフセット - ページ・サイズおよびオフセット(開始行)パラメータを使用して、REST APIで特定の行セットをリクエストできる柔軟なページ区切りです。

      一般的なURLを次に示します。この例では、URLはページ・サイズが100のページ番号2をリクエストし、行101から行200が返されます。

      http://hostname.domain.com/path/to/rest_api?limit=100&offset=20

      前述の例では、limitおよびoffsetというパラメータを任意にして、使用されるREST APIによって決まるようにできます。

    • ページ・サイズとページ番号 - ページ・サイズおよびページ番号パラメータを使用して、REST APIで行のセットをリクエストできるページ区切り。

      通常、URLは次の例のように、ページ・サイズが100のページ番号2をリクエストし、行101から行200が返されます。

      http://hostname.domain.com/path/to/rest_api?size=100&page=2

    • ページ番号 - ページ・パラメータを使用して、REST APIで行のセットをリクエストできるページ区切り。ページ・サイズは固定され、REST APIによって決定されます。

      通常、URLは次の例のように、ページ番号2をリクエストします。REST APIで固定ページ・サイズ20を使用している場合、行21から行40が返されます。

      http://hostname.domain.com/path/to/rest_api?page=2

    • ページ・サイズとページ・トークン - REST APIでページ・トークン・パラメータとページ・サイズ・パラメータを組み合せて行のセットをリクエストできるページ区切り。このトークンは、次の行セットを取得するために使用され、前のリクエストのレスポンス本文で返されます。このページ・サイズによって、各リクエストで返される行の数が決まります。

      URLは通常、次の例のようになります。この例では、トークンApEx=とページ・サイズ100を使用して次の行セットをリクエストしています。

      http://hostname.example.com/path/to/rest_api?token=ApEx=&limit=100

    選択したページ区切りタイプに基づいてUIが変更されます。特定の属性の詳細は、フィールドレベル・ヘルプを参照してください。

  6. 「RESTデータ・ソース・タイプ」が「REST有効SQL問合せ」の場合、「設定」の「REST対応SQL問合せ」で次のようにします:
    • SQL問合せ - REST対応SQL参照で実行するSQL問合せを表示します。
  7. 「認証」で、次の項目を指定します。
    • 資格証明 - 認証用の保存済資格証明を選択します。
    • 認証サーバー - 認証を(別の)認証サーバーで行う必要がある場合は、認証用のリモート・サーバー・オブジェクトを作成して、ここで選択します。詳細は、フィールドレベル・ヘルプを参照してください。
  8. 「データ・プロファイル」で、次のステップを実行します。
    1. 「データ・プロファイルの編集」をクリックして、RESTデータ・ソースのレスポンス(XMLまたはJSON)形式を解析して行および列に変換する方法を変更します。
      データ・プロファイル・ページが表示されます。
    2. 「データ・プロファイル」および「列」で、属性を編集します。
      「行セレクタ」は、行の集合を含むノードをポイントするXMLまたはJSONパス式を格納します。「列」は、1つの行を解析して複数の列に変換する方法を決定します。
    3. 「変更の適用」をクリックして、変更を保存します。
  9. 操作 - 「操作」には、外部Webサービス・ハンドラに関する実際の情報が含まれています。操作はデータベース操作にマップでき、これによりAPEXコンポーネントが正しい操作を取得できます。
    1. 操作を追加または編集するには:
      • 「操作の追加」をクリックして、RESTデータ・ソース操作を追加します。
      • 「編集」アイコンをクリックして、既存の操作を編集します。

      「RESTソース操作」ページが表示されます。

    2. 「操作」で、次の項目を指定します。

      • URLパターン - URLパターンは、Webサービス・エンドポイントURLの最後の部分です。URLパターンとHTTP操作(GET、POST、PUT、DELETE)の組合せによって、RESTデータ・ソース内の操作が識別されます。

      • HTTPメソッド - REST Webサービスで実行するHTTP操作またはメソッド(GET、POST、PUT、DELETE、PATCH)を定義します。

      • データベース操作 - このHTTP操作にデータベース操作を割り当てます。データベース操作は、APEXコンポーネントがRESTデータ・ソースと連携するために重要です。

      これらの属性の詳細および例についてさらに学習するには、フィールドレベル・ヘルプを参照してください。

    3. 「キャッシュ」で、次の項目を指定します。

      • キャッシュ - APEXエンジンがサーバー側でRESTソース・レスポンスをキャッシュできる方法を選択します。キャッシュを使用できる場合、コンポーネントは、Webサービスから再度フェッチするのではなく、キャッシュされた結果に基づいてレンダリングされます。HTTP GETリクエストのみがキャッシュされ、コストのかかるHTTPリクエストが削減されます。この機能は、ブラウザのキャッシュ機能とは無関係です。

      • 次の場合に無効化 - 「キャッシュ」を有効にする場合は、キャッシュされたコンテンツをいつ無効にするかを指定します。分数またはDBMS_SCHEDULERカレンダ文字列を指定します。後者の場合、キャッシュされたコンテンツが、正時、午前0時または特定の時点で無効になるように決定します。

      これらの属性の詳細および例についてさらに学習するには、フィールドレベル・ヘルプを参照してください。

    4. 「操作パラメータ」で、「パラメータの追加」をクリックしてRESTデータ・ソース・パラメータを構成します。

      パラメータを使用すると、動的URL部分をサポートしたり、追加のHTTPリクエスト・ヘッダーまたは特定のリクエスト本文をWebサービスに渡すことができます。Oracle APEXコンポーネントは、Webサービスを起動する前にパラメータに値を割り当てます。これらの属性の詳細および例についてさらに学習するには、フィールドレベル・ヘルプを参照してください。

    5. 「詳細」で、次の項目を指定します。

      • 固定ページ・サイズ - RESTサービスのページ区切りウィンドウのサイズを入力します。リソース・ハンドラHTTP操作GETメソッドのページ区切りは、データベース問合せに基づくJSON書式結果セットのページごとに返される行の数です。

      • 静的ID - このREST操作にプログラムからアクセスするための静的IDを指定します。静的IDは小文字に変換され、英数字以外または特殊文字はすべてアンダースコア(_)に置き換えられます。

      • 操作コメント - 開発者のコメントを入力します

      これらの属性についてさらに学習するには、フィールドレベル・ヘルプを参照してください。

    6. 「変更の適用」をクリックします。
  10. 「パラメータ」 - 「パラメータ」では、動的URL部分をサポートしたり、追加のHTTPリクエスト・ヘッダーや特定のリクエスト本文をWebサービスに渡すことができます。APEXコンポーネントは、Webサービスを起動する前にパラメータに値を割り当てます。
    1. 「パラメータの追加」をクリックします。
      「パラメータ」ページが表示されます。
    2. 「RESTデータ・ソース・パラメータの編集」で、次の項目を指定します。

      • 属性を編集します。属性についてさらに学習するには、フィールドレベル・ヘルプを参照してください。

      • 「パラメータの追加」または「追加後、さらに追加」をクリックします。

    3. 「RESTデータ・ソース・パラメータの編集」で属性を編集し、「パラメータの追加」をクリックします。属性についてさらに学習するには、フィールドレベル・ヘルプを参照してください。
  11. 「サブスクリプション」には、このモジュールをサブスクライブするRESTデータ・ソースがリストされ、このRESTデータ・ソースがコピーかどうかを示します。
  12. 「Open API」で、次の操作を実行します:
    1. Open API - 「OpenAPIの使用」を有効または無効にします。有効にすると、RESTデータ・ソースは検出にOpenAPI/Swaggerを使用します。
    2. 「エンドポイントは、ベースURLに対して相対的です」 - OpenAPIエンドポイントがリモート・サーバーのベースURLに対して相対的かどうかを選択します。
    3. 「OpenAPI URL」 - OpenAPI情報が使用可能なURLを入力します。これは、サービスのベースURLに対する絶対URLまたは相対URLです。
  13. RESTソース・カタログ - 「カタログに保存」をクリックして、RESTデータ・ソースをRESTソース・カタログに保存します。「RESTソース・カタログの管理」を参照してください。
  14. 「詳細」で、次の項目を指定します。
    1. 静的ID - 静的IDを使用して、APIコールでRESTデータ・ソースを参照します。
    2. ECIDを渡す - エンドツーエンドのトレースのために実行コンテキストID (ECID)を外部Webサービスに渡すかどうかを示します。
      「共有コンポーネント」、「セキュリティ属性」、「拡張」、「ECIDを渡す」のアプリケーション設定の詳細は、拡張を参照してください。
    3. HTTP転送のタイムアウト - Webサーバーまたはプロキシ・サーバーからのHTTPレスポンスの読取り中に試行されたすべての将来のHTTPリクエストの転送タイムアウトを指定します。
      このタイムアウト値は、レスポンスの取得中に、ビジーなWebサーバーや大量のネットワーク・トラフィックによってアプリケーションがブロックされないようにするために使用できます。『Oracle Database PL/SQLパッケージおよびタイプ・リファレンス』のSET_TRANSFER_TIMEOUTプロシージャに関する項を参照してください
    4. コメント - コメントまたはノートを入力します。
  15. 変更を保存するには、「変更の適用」をクリックします。

親トピック: RESTデータ・ソースの編集または削除

18.4.4.2 RESTデータ・ソースの削除

「共有コンポーネント」からRESTデータ・ソースを削除します。

ヒント:

RESTデータ・ソースは、Oracle APEXコンポーネントによって参照されていない場合にのみ削除できます。

RESTデータ・ソースを編集または削除するには:

  1. 「RESTデータ・ソース」ページにナビゲートします。
    1. ワークスペースのホームページで、「アプリケーション・ビルダー」をクリックします。
    2. アプリケーションを選択します。
    3. アプリケーションのホームページで、ページの中央にある「共有コンポーネント」をクリックします。
    4. 「データ・ソース」で、「RESTデータ・ソース」を選択します。
  2. 「RESTデータ・ソース」ページで、「RESTソース名」をクリックします。
    「RESTデータ・ソース」ページが表示されます。
  3. RESTデータ・ソースを削除するには、「削除」をクリックします。
  4. 選択内容を確認して、「OK」をクリックします。

親トピック: RESTデータ・ソースの編集または削除