「RESTメソッド定義」ダイアログ

「RESTメソッド定義」ダイアログを使用して、WADLおよびタイプ付きでないペイロードをスキーマなしで使用するSOA RESTサービスまたは参照のRESTメソッドを定義します。

表37-3 「RESTメソッド定義」ダイアログ

フィールド 説明

メソッド

定義するRESTメソッドの名前を入力します。

リソース

既存のURLリソース・パスをリストから選択するか、「追加」アイコンをクリックして新しいリソース・パスを追加します。

「HTTP動詞」

WSDL操作にバインドされる動詞(GETPUTPOSTDELETEなど)を選択します。

説明

説明を入力します(オプション)。これは、メソッドについて公開される説明テキストです。

リクエスト

「ペイロード」セクションでは、リクエスト・ペイロードの形式を指定できます:
  • JSON (デフォルトの選択)
  • XML
  • URL-エンコード
  • テキスト
  • 不透明
  • ペイロードなし
  • その他: 「その他」オプションを選択して、マルチパート・フォーム・データを含むRESTバインディングを構成し、multipart/formdataを指定します。マルチパート・フォーム・データのサポートにより、Oracle Databaseとの間でファイルの受信とアップロードが可能になります。インバウンド(アップロード)リクエストとアウトバウンド(ファイル読取り)リクエストの両方を処理し、マルチパート・フォーム・データをサポートするREST APIをコールできます。

「メソッドのサンプルURLを生成します」をクリックして、メソッド操作のサンプルURLを表示します。

「URIパラメータ」セクションでは、REST問合せまたはテンプレート・パラメータから対応するランタイム・プロパティへのマッピングを指定できます。

  1. 「メソッドのサンプルURLを生成します」アイコン(最初のアイコン)をクリックして、以前入力したすべてのバインディング情報に基づいてサンプルURLを生成します。このオプションは通常、すべてのパラメータを構成した後に選択します。

  2. 「パラメータの追加」アイコン(2番目のアイコン)をクリックして、マッピング・パラメータを手動で追加します。

  3. 「スタイル」で、「問合せ」または「テンプレート」を選択します。テンプレート変数は、通常、POST操作およびPUT操作に使用されます。問合せパラメータは、通常、GET操作およびDelete操作に使用されます。

  4. 「タイプ」で、パラメータのデータ型を選択します。すべてのXSDプリミティブ型がサポートされています。

  5. 「デフォルト値」で、パラメータの設計時のデフォルト値を設定できます。RESTリクエストにURIパラメータがない場合は、RESTサービスによって対応するデフォルト値が使用されます。

  6. 「ランタイム・プロパティ」に、メソッド・パラメータのマッピング先のランタイム・プロパティの名前が表示されます。

問合せパラメータに値を割り当てるには:

  1. RESTバインディング・コンポーネントをコールする起動アクションをダブルクリックします。
  2. 「プロパティ」「終了」を選択します。
  3. ドロップダウン・リストから問合せパラメータを選択し、変数または式を割り当てます。invokeアクティビティの詳細は、「invokeアクティビティ」を参照してください。

レスポンス

成功および失敗セクションでは、レスポンス・ペイロードとメソッドのステータスを選択できます。

デフォルトのレスポンス・ペイロードは「ペイロードなし」です。成功した操作のデフォルトのHTTPステータス・コードは204で、失敗した操作の場合は500です。