「REST操作バインディング」ダイアログ

「REST操作バインディング」ダイアログを使用し、WSDLインタフェースを使用してコンポーネントを起動するRESTサービスのREST操作を定義します。リソース・パスおよびREST操作を定義できます。REST定義からWSDLへのマッピングが含まれた基礎となるWSDLが生成されます。

表37-2 「REST操作バインディング」ダイアログ

フィールド	説明
メソッド	マッピングするWSDL操作名を表示します。生成されたWSDLで使用されている名前を指定できます。
リソース	既存のURLリソース・パスをリストから選択するか、「追加」アイコンをクリックして新しいリソース・パスを追加します。 選択したリソース・パスが、このダイアログの下部にある「リクエスト」セクションの「URIパラメータ」表に追加されます。選択したリソースに{var}などのテンプレート変数が含まれている場合、その変数がURIパラメータに追加されます。
「HTTP動詞」	実行する操作(たとえばGET、PATCH、PUT、POST、DELETEなど)を選択します。 リクエストのスキーマを選択すると、動詞に基づいてアクションが実行されます。動詞にペイロードがない場合(GET、DELETE)、URIパラメータが追加されます。「URIパラメータ」表に、受信REST問合せパラメータからWSDLスキーマへのマッピングが移入されます。PATCH動詞はリソースの一部を更新する場合に使用し、PUT動詞はリソース全体を置換する場合に使用します。 操作のHTTP動詞は、「RESTバインディングの作成」ダイアログの「操作バインディング」セクションにも追加かされます。
説明	説明を入力します(オプション)。参照バインディング・コンポーネントには、「ベースURI」フィールドがあります。
リクエスト	「スキーマ」セクションには、使用されているリクエスト・スキーマが表示されます。 スキーマURL: 使用するリクエスト・スキーマが表示されます。「RESTバインディングの作成」ダイアログで「RESTコンポーネントや参照の有効化」を選択した場合、スキーマはサービスの操作WSDLから取得されるため、このフィールドは読取り専用になります。「RESTバインディングの作成」ダイアログで「操作バインディングの追加」を選択した場合、スキーマを参照するか、ネイティブ・フォーマット・ビルダー・ウィザードを使用してサンプルから新しいスキーマを作成する必要があります。 要素: 使用する要素が表示されます。 「ペイロード」セクションでは、リクエスト・ペイロードの形式として、XML (デフォルト選択項目)、JSON、URLエンコード、テキスト、不透明またはペイロードなしを指定できます。「その他」オプションを選択して、カスタム・ペイロード・タイプを定義できます。「サンプル・ペイロードの生成」をクリックして、選択したリクエスト・ペイロードのサンプルを表示します。 「URIパラメータ」セクションでは、REST問合せパラメータからWSDLスキーマへのマッピングを指定できます。このセクションは、「HTTP動詞」リストでスキーマを指定する際に(動詞に応じて)自動的に移入されます。GET動詞およびDELETE動詞では、パラメータはWSDLスキーマにバインドされます。POST動詞およびPUT動詞では、インバウンド・ペイロードがWSDLスキーマにマッピングされます。 「操作用のサンプルURLを生成」アイコン(最初のアイコン)をクリックして、以前入力したすべてのバインディング情報に基づいてサンプルURLを生成します。このオプションは通常、すべてのパラメータを構成した後に選択します。 「パラメータの追加」アイコン(2番目のアイコン)をクリックして、マッピング・パラメータを手動で追加します。 「スタイル」列で特定の行をクリックするとリストが呼び出され、このリストで問合せまたはテンプレートを選択できます。テンプレート変数は、通常、POST操作およびPUT操作に使用されます。問合せパラメータは、通常、GET操作およびDelete操作に使用されます。 「タイプ」列で、パラメータのデータ型を選択します。すべてのXSDプリミティブ型がサポートされています。多くの場合、パラメータがスキーマから自動的に生成されるときにタイプが設定されます。新しいパラメータを作成した場合は、「タイプ」列でリストからタイプを選択できます。 「デフォルト値」列で、パラメータの設計時のデフォルト値を設定できます。RESTリクエストにURIパラメータがない場合は、RESTサービスによって対応するデフォルト値が使用されます。 「式」列で特定の行をクリックすると、xpath-expression関数を追加するための「式ビルダー」ダイアログが表示されます。スキーマが操作に対して定義されていない場合、「式ビルダー」パラメータにはプロパティ変数のみが表示され、メッセージ変数は表示されません。式によってパラメータがWSDLスキーマのフィールドにバインドされます。パラメータが自動的に生成される(既存または生成されたスキーマに基づいて)すべての場合に、この式はすでに自動的に生成されています。新しいパラメータを追加する場合や実行時プロパティなどの別のものにバインドする場合にのみ、式を追加します。XPath式は、特定のURIパラメータを正規化されたメッセージに挿入する場所を指定します。 問合せパラメータに値を割り当てるには: RESTバインディング・コンポーネントをコールする起動アクションをダブルクリックします。 「プロパティ」→「終了」を選択します。 ドロップダウン・リストから問合せパラメータを選択し、変数または式を割り当てます。invokeアクティビティの詳細は、「invokeアクティビティ」を参照してください。
レスポンス	「HTTPステータス」セクションでHTTPステータス・コードを指定できます。空白で区切られた複数のステータスを入力できます。参照では、成功と解釈される可能性のあるステータスがあります。サービスでは、返すことができる可能性のある成功ステータス(BPELなどのサービス・コンポーネントによって設定)があります。 「ペイロード」セクションで、可能なレスポンス・ペイロードとして、XML (デフォルト)、JSON、URLエンコード、テキスト、不透明またはペイロードなしを指定できます。「その他」オプションを選択して、カスタム・ペイロード・タイプを定義できます。実行時に返される出力は、受信リクエストに応じて異なります。「サンプル・ペイロードの生成」をクリックして、選択したレスポンス・ペイロードのサンプルを表示します。 「スキーマ」セクションには、可能なペイロードのタイプが選択されている場合に使用されるレスポンス・スキーマが表示されます。ペイロードなしが選択されている場合、このフィールドは表示されません。 スキーマURL: 使用するレスポンス・スキーマが表示されます。スキーマを指定していない場合は、既存のスキーマを参照するか、ネイティブ・フォーマット・ビルダー・ウィザードを使用してサンプルから新しいスキーマを作成するかを選択できます。このウィザードでは、JSON Interchangeフォーマット、XMLサンプル、URIエンコード形式またはURIサンプルのいずれかでスキーマを作成できます。詳細は、「サンプルからのスキーマの生成方法」を参照してください。 要素: 使用する要素が表示されます。 「フォルト・バインディング」セクションには、レスポンス・フォルト名、タイプ、ステータスおよびスキーマが表示されます。フォルトの詳細がWSDLファイルで定義されている場合は、フォルト・バインディングがこのセクションに自動的に作成されます。フォルト・バインディングは、「追加」アイコンをクリックして、手動でも定義できます。フォルトの詳細は、「RESTフォルト・バインディングに関する必知事項」を参照してください。