先日の記事で作成したRESTデータ・ソースをアプリケーションで使ってみます。RESTデータ・ソースはoracle.example.hrとして作成済みとします。
上記の３つの操作ですが、適切に使用するために設定の修正を行います。
対話モード・レポートとフォームの作成
RESTデータ・ソースoracle.example.hrをソースとした対話モード・レポートとフォームのページを作成します。
ページの作成を実行します。
対話モード・レポートを選択します。
対話モード・レポートのページの名前は従業員一覧、ページ・モードは標準とします。フォーム・ページを含めるをオンにし、フォーム・ページ名は従業員編集とします。フォーム・ページ・モードはドロワーとします。
データ・ソースにRESTデータ・ソースを選択し、RESTデータ・ソースとしてoracle.example.hrを選びます。
ナビゲーションはデフォルトまま変更しません。
以上の設定で、次へ進みます。
対話モード・レポートとフォームのページが作成されます。
作成された対話モード・レポートのページを実行します。
適当な従業員を選んで、編集リンクをクリックします。
そのまま変更の適用をクリックします。
select * from apex_webservice_log order by request_date desc;
編集リンクをクリックしたときもGET /empinfo/が呼び出されています。全件を取得した上で、その中から編集対象の一行を取り出す、という動作になります。
従業員一覧を再度開き、発行されたREST APIを確認します。すべての行を取り出すために、limitで指定されている６行ごとに３回、REST APIを発行していることが確認できます。
対話モード・レポートの一覧表示ではGET /empinfo/が呼び出されています。Swagger Editorでの説明は以下です。ページ区切りの設定を行なっていないと全件を取得します。
サンプル・データセットの表EMPは初期状態で14行なので問題ありませんが、何千件、何万件といった行数になると、ページ区切りを実装するか同期化を使って取得結果をローカル・データベースにキャッシュする必要が出てくるでしょう。
これでは実用上の問題があるため、RESTデータ・ソースの操作に含まれる単一行のフェッチ（GET /employees/{id}）を呼び出すように変更します。
編集フォーム上で変更の適用をクリックしたときは、GET /employees/が呼び出されています。これは行の更新（PUT employees/{id}）の呼び出しに置き換えます。
ページ区切りの設定
使用しているRESTデータ・ソースoracle.example.hrは、Oracle REST Data Servicesで実装しています。Oracle REST Data Servicesでは（ソース・タイプがCollection Queryの場合）、ページ区切り（ページネーションとも呼びます）がデフォルトで実装されます。
ORDSのProduct ManagerであるJeff Smithさんの以下の記事を参考にして、RESTデータ・ソースoracle.example.hrにページ区切りを設定します。
How Paging Works in ORDS
RESTデータ・ソースoracle.example.hrを開き、設定のセクションに移動します。
ページ区切りタイプとしてページ・サイズとフェッチ・オフセットを選択します。ページ・サイズURLパラメータはlimit、ページ・サイズ最大は６とします（適切な値は、対話モード・レポートの１ページで表示される行数よりも大きい値です）。行オフセットURLパラメータはoffset、行オフセット・タイプとしてスキップする行を選択します。ORDSの場合、offsetは0から始まります。その他の行セレクタとしてhasMoreを指定し、次の値のときのその他の行に次と等しい、その他の行属性値にtrueを指定します。
上記はORDSで決められた定義です。RESTサービスの実装が異なれば、上記の設定も異なります。
/empinfo/?offset=0&limit=6
/empinfo/?offset=6&limit=6
/empinfo/?offset=12&limit=6
ページごとの行数を５行にします。
/empinfo/?offset=0&limit=6
次のページに移動すると、表示される対象の行（以下の例では６行目）からデータを取得します。
発行されるREST APIは以下の１回です。
/empinfo/?offset=5&limit=6
単一行のフェッチの実装
GET /empinfo/を実行し、すべての行をフェッチしてから編集する行を取り出す処理は非効率なので、単一行のフェッチの呼び出しに置き換えます。
GET employees/{id}を呼び出すと、id（列EMPNOの従業員番号）指定で選択された表EMP
の行がJSON形式で返されます。OpenAPI定義から生成されたRESTソース操作では、返却されるJSONドキュメントの処理が行われていません。
単一行のフェッチの操作を開いて、返却された値の定義を追加します。
返却されるJSONドキュメントにどのような属性が含まれるかは、OpenAPIによる定義に含まれています。
パラメータのタイプとしてデータ・プロファイル列を選択し、データ・プロファイル列として、最初にCOMMを選択します。
追加後、さらに追加をクリックします。
操作パラメータをすべて設定した後、変更の適用を実行します。
以上でRESTデータ・ソースの操作の更新は完了です。
ページ・デザイナにて従業員編集の画面を開きます。
レンダリング前にあるプロセス初期化フォーム従業員編集を選択し、ビルド・オプションを使ってコメント・アウトします。削除しても構いません。
代わりになるプロセスを従業員画面の初期化として作成します。
識別のタイプとしてAPIの呼び出しを選択します。設定のタイプはREST Sourceを選択します。Oracle APEX 23.1から、APIの呼び出しでREST Sourceを指定できるようになりました。
RESTソースとしてoracle.example.hr、操作としてGET - employees/{id}を選択します。
サーバー側の条件のタイプにアイテムはNULLではない、アイテムとしてP3_EMPNOを指定します。従業員番号が与えられている場合のみ、RESTソースを呼び出しページ・アイテムに値を設定します。
パラメータのidを選択し、値のアイテムとしてP3_EMPNOを割り当てます。
パラメータのEMPNOを選択します。出力を無視がオンになっています。
EMPNOに対応するページ・アイテムP3_EMPNOは、対話モード・レポートの編集リンクをクリックしたときに引数として渡されるため、このプロセスで初期化する必要はありません。このまま、出力を無視はオンにしておきます。
パラメータのCOMMを選択します。
出力を無視をオフに変更し、値のアイテムとしてP3_COMMを指定します。
同様にパラメータDEPTNOにページ・アイテムP3_DEPTNO、ENAMEにP3_ENAME、HIREDATEにP3_HIREDATE、JOBにP3_JOB、MGRにP3_MGR、SALにP3_SALを設定します。
以上でフォームの初期化プロセスの入れ替えは完了です。
対話モード・レポートのページを実行し、任意の一行の編集画面を開きます。
発行されたREST APIをビューAPEX_WEBSERVICE_LOGから確認すると、以下のようなリクエストが発行されていることが分かります。
GET /employees/7654
行の更新の実装
行の更新を実装します。OpenAPIでは、以下のようなJSONドキュメントをリクエスト本体として送信するように定義されています。
{
"ename": "string",
"job": "string",
"hiredate": "string",
"mgr": "string",
"sal": "string",
"comm": "string",
"deptno": "string"
}操作の行の更新を開いて、上記のようなREST APIを発行するように設定します。
リクエスト本文テンプレートに何も設定されていません。生成をクリックします。
リクエスト本文テンプレートが生成されます。
操作パラメータに本文との同期というボタンが現れます。これをクリックします。
リクエスト本文にプレースホルダーがない操作パラメータが削除されると警告が表示されます。今回の例ではpayloadが削除されます。
payloadは不要なので、OKをクリックします。
リクエスト本文テンプレートに含まるプレースホルダーが、操作パラメータとして追加されます。
パラメータの追加をクリックし、Content-Typeヘッダーを追加します。
パラメータのタイプとしてHTTPヘッダーを選択します。名前はContent-Type、目的は入力、デフォルト値としてapplication/jsonを指定します。
静的をオンにし、変更不可のパラメータとします。
パラメータの追加をクリックします。
以上でRESTソース操作の設定は完了です。
ページ・デザイナにて従業員編集の画面を開きます。
プロセスのプロセス・フォーム従業員編集を選択し、ビルド・オプションを使ってコメント・アウトします。削除しても構いません。
代わりになるプロセスを従業員の更新として作成します。
識別のタイプとしてAPIの呼び出しを選択します。設定のタイプはREST Sourceを選択します。RESTソースとしてoracle.example.hr、操作としてPUT - employees/{id}を選択します。
サーバー側の条件のボタン押下時としてSAVEを指定します。
パラメータのidを選択し、値のアイテムとしてP3_EMPNOを割り当てます。
それ以外はパラメータ名とページ・アイテム名がページ番号の部分を除き一致しているため、自動的に値のアイテムが割り当たっています。
HIREDATEについては、REST API側が受け付ける日付フォーマットが英語になっています。そのためパラメータHIREDATEを選択し、値のタイプに式、言語としてPL/SQLを選択して、PL/SQL式として以下を記述します。
to_char(to_date(:P3_HIREDATE,'YYYY/MM/DD'),'DD-MON-YYYY','NLS_DATE_LANGUAGE=American')
以上でフォームの更新プロセスの入れ替えは完了です。
アプリケーションを実行し、従業員のデータが編集できることを確認します。
本記事は以上になります。
Oracle APEXのアプリケーション作成の参考になれば幸いです。
完
