RESTデータ・ソースの作成

「RESTデータ・ソース」ページにナビゲートします。

ワークスペースのホームページで、「アプリケーション・ビルダー」をクリックします。
アプリケーションを選択します。
アプリケーションのホームページで、ページの中央にある「共有コンポーネント」をクリックします。
「データ・ソース」で、「RESTデータ・ソース」を選択します。

「RESTデータ・ソース」ページで、「作成」をクリックします。

メソッド: 「最初から」を選択し、「次」をクリックします。

ヒント:

「既存のRESTデータ・ソースのコピーとして」を選択した場合は、コピーするアプリケーションを選択して、画面に表示される手順に従います。

一般:

RESTデータ・ソース・タイプ - RESTデータ・ソース・タイプ(組込みタイプまたはRESTソース・プラグインで定義されたタイプ)を決定します。使用可能な組込みRESTデータ・ソース・タイプは、次のとおりです。
- 簡易HTTP: 単純なHTTPデータ・フィードの場合は、このオプションを選択します。Oracle APEXでは、すべてのデータは最初のリクエストで返され、サーバーはサーバー側のフィルタ、順序付けまたはその他の拡張RESTサービス機能をサポートしないと想定されます。呼出しの詳細とパラメータはすべて手動で構成する必要があります。
- Oracle REST Data Services: Oracle REST Data Services (ORDS)を示します。これらのRESTサービスはOracle REST標準に準拠しており、GET、POST、PUT,またはDELETE操作が標準化されています。サーバー側フィルタリングと順序付けがサポートされます。Oracle APEXでは、レポートの並替え基準およびフィルタをRESTサービスに委任することで、これらの機能を利用できます。
- REST対応SQL問合せ: REST対応SQL参照で実行されるSQL問合せに基づいてRESTソースを示します。Oracle APEXでは、フィルタ処理およびページ区切りがサポートされますが、これらのエンドポイントではDMLはサポートされません。
- Oracle Cloud Applications (SaaS) REST Service: Oracle Cloud SaaS Applicationsによって提供されるRESTful Webサービスを示します。このWebサービス・タイプを使用して、Oracle SaaS REST ServicesをOracle APEXアプリケーションに統合します。Oracle APEXでは、これらのサービスに対してページ区切りがサポートされます。
- Oracle Cloud Infrastructure (OCI) REST Service: Oracle Cloud Infrastructureによって提供されるRESTful Webサービスを示します。このWebサービス・タイプを使用して、OCI REST Service (オブジェクト・ストアへのアクセスなど)をOracle APEXアプリケーションに統合します。Oracle APEXでは、これらのサービスに対してページ区切りがサポートされます。
「RESTデータ・ソース・タイプ」に応じて、この後に表示される内容が決まります。この例では、「RESTデータ・ソース・タイプ」が「簡易HTTP」に設定されています。
名前: このRESTデータ・ソースのわかりやすい名前を入力します。
URLエンドポイント: このRESTデータ・ソースのエンドポイントURL (http://またはhttps://で始まる)を入力します。

ヒント:

?name1=value&name2=valueを付加して、問合せ文字列パラメータを追加しないでください。これらは、認証を構成した後に「詳細」ウィザード・ページで構成します。
HTTPSホスト名: HTTPSリクエストに対してリモート・サーバーの証明書の共通名(CN)と照合するホスト名。これは、*.example.comのようなドメイン名でもある場合があります。NULLである場合、特定のURL内のホスト名が使用されます。
「次」をクリックします。

リモート・サーバー:

リモート・サーバー: 既存のリモート・サーバー・オブジェクトを選択します。RESTデータ・ソースのHTTPエンドポイントURLは、リモート・サーバー(ベースURL)とサービス固有の部分で構成されます。リモート・サーバーは、個別のエンティティとして保存されます。複数のRESTデータ・ソースが同じリモート・サーバーを共有する場合、リモート・サーバー定義内のベースURLを変更するのみで、それらを別の物理的な場所(テストから本番など)に簡単にリダイレクトできます。
ベースURL: これは、選択したリモート・サーバー・オブジェクトのベースURLです。このRESTデータ・ソースのHTTPエンドポイントURLは、ベースURLと次のサービス固有のパス接尾辞で構成されます。
次に例を示します。
- http://api.example.com:8080/myservices/test/
- https://api.example.com/ords/scott/
サービスURLパス: このRESTデータ・ソースのサービス固有のURLパスを入力します。HTTPエンドポイントURLは、これを、リモート・サーバー・オブジェクトで指定されたベースURLに付加することで生成されます。
次に例を示します。
- /services/customers/
- /products/4711/details
「次」をクリックします。

「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

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

認証が必要です: 新しいRESTデータ・ソースが認証を必要とするかどうかを選択します。

ヒント:

認証の詳細は、「有効なURLの定義によるWeb資格証明の保護」のサポートされている認証タイプについてを参照してください

続行するには、次のいずれかを選択します。

RESTソースの手動作成: このオプションには、検出モードが含まれていません。以前に入力した情報に基づいて、いくつかのサンプル操作とサンプル・データ・プロファイルでRESTデータ・ソースが作成されます。このオプションでは、APEXコンポーネントで使用できない不完全なRESTデータ・ソースが作成されます。外部Webサービスを正しく反映するには、操作とデータ・プロファイルを編集する必要があります。
詳細: データ・プロファイルの詳細パラメータを表示します。「レスポンス・サンプル」を使用して、サンプルのJSON (またはXML)レスポンスをアップロードします。ファイルがアップロードされると、アップロードされたファイルに対してAPEXがデータ・プロファイル検出を実行します。
検出: 検出モードを開始します。APEXで、外部のWebサービスに関する情報を取得するために、複数のHTTPリクエストが実行されます。APEXで、Webサービスによって返されたデータ(JSONまたはXML)のサンプルを取得し、データ・プロファイル(JSON属性に関するメタデータで構成される)を導出します。その後、検出結果が表示され、RESTデータ・ソースを作成するかどうかが確認されます。

「詳細」をクリックすると、パラメータ・ページが表示されます。

パラメータ・ページを使用して、検出で必要になる可能性がある初期RESTデータ・ソース・パラメータを構成します。一部のRESTデータ・ソースでは、特定のHTTPヘッダー(User-Agentなど)の設定が必要になる場合があります。詳細パラメータを設定したら、「RESTソースの手動作成」または「検出」を選択します。

「検出」を選択すると、APEXによってRESTサービスURLが呼び出され、プレビューが表示されます。APEXでは、JSONレスポンスから属性とそのデータ型が導出され、それを使用してデータ・プロファイルが作成されます。

表示される情報は、ターゲット・サービスの複雑さによって異なります。JSONレスポンス属性に関するメタデータを提供しない簡易HTTPサービスまたはORDSサービスの場合、APEXによって、JSONまたはXMLレスポンスが調査されて、データがサンプリングされて、データ・プロファイルの提案が作成されます。「データ」タブには、サンプル・レスポンス・データがレポート形式で表示されます。

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

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

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

RESTデータ・ソースが作成されます。