外部 Web サービスの追加

REST Web サービスの場合:

URL

[記述子] ステップで WADL を指定しなかった場合は、パス パラメータ (あれば) と、要求に含めるクエリ パラメータを含む、サンプル要求 URL を入力します。例:

http://example.com/rest/customers/{state}?age=31

ここには、1 つのパス パラメータ {state} と 1 つのクエリ パラメータ age があります。

[記述子] ステップで WADL を指定した場合は、指定した WADL に基づくエンドポイントが [URL] フィールドに表示されます。このエンドポイントを編集することはできません。

Resource

この設定は、[記述子] ステップで WADL を指定した場合のみ表示されます。Spectrum™ Technology Platform 上に公開する Web サービスのリソースを選択します。

注: 2 つ以上のリソースを公開したい場合は、各リソースに対して個別の外部 Web サービスを定義する必要があります。

方法

外部の Web サービスへの要求に使用する HTTP メソッドを選択します。

[記述子] ステップで WADL を指定した場合は、その外部 Web サービスによってサポートされている HTTP メソッドのみがリストに表示されます。

パス パラメータ

[パス パラメータ] セクションには、その外部 Web サービスがパス パラメータを使用する場合は、URL パスに含まれるパラメータが一覧表示されます。例えば、この URL にはパス パラメータ {state} が含まれます。

http://example.com/rest/customers/{state}?age=31

[記述子] ステップで WADL を指定した場合は、Web サービスのパス パラメータがリストに表示されます。[記述子] ステップで WADL を指定しなかった場合は、[URL] フィールドに入力したサンプル要求 URL からパス パラメータのリストが生成されます。パス パラメータを追加または削除するには、URL からそれを追加または削除します。URL の中の波括弧で囲まれた部分はすべて、パス パラメータとして解釈されます。

クエリ パラメータ

[クエリ パラメータ] セクションには、要求 URL 内で "?" の後に記述されるパラメータのリストが表示されます。例えば、この URL にはクエリ パラメータ age が含まれます。

http://example.com/rest/customers/{state}?age=31

[記述子] ステップで WADL を指定した場合は、Web サービスのクエリ パラメータがリストに表示されます。[記述子] ステップで WADL を指定しなかった場合は、[URL] フィールドに入力したサンプル要求 URL からクエリ パラメータのリストが生成されます。クエリ パラメータを追加または削除するには、URL からそれを追加または削除します。

表 1. REST パス パラメータとクエリ パラメータの設定

設定	説明
エクスポーズ	Spectrum™ Technology Platform ステージでパラメータを使用可能にするには、この列のチェックボックスをオンにします。
要求	この列には、外部 Web サービスへの要求に使用されるパラメータ名がリスト表示されます。
入力	この列には、フローで表示される時の入力フィールドの名前がリストされます。サードパーティの Web サービスで使用されていたものと同じ名前を使用することも、変更することもできます。名前を変更するには、名前の上にカーソルを合わせて編集ボタン をクリックします。
デフォルト値	フィールドのデフォルト値を指定する場合は、このチェックボックスをオンにします。チェックボックスをオンにした後に表示されるフィールドにデフォルト値を入力します。 フローからオーバーライドできないデフォルト値を指定するには、[デフォルト値] 列のチェックボックスをオンにして、[要求] 列の対応するボックスをオフにします。これによって、外部の Web サービスへの要求でデフォルト値を指定する場合に、フローにおいてそのフィールドは非表示となります。要求ごとに指定する必要のあるアクセス キーがある場合は、これが便利です。例:

SOAP Web サービスの場合:

URL

このフィールドには、[記述子] ステップで指定した WADL に基づくエンドポイントが表示されます。このフィールドは編集できません。

操作

実行する Web サービスの操作を選択します。

注: 2 つ以上の操作を公開したい場合は、各操作に対して個別の外部 Web サービスを定義する必要があります。

要求

この列では、Spectrum™ Technology Platform を通じて利用可能にするフィールドとオプションを選択します。

入力

この列には、フローで表示される時の入力フィールドの名前がリストされます。サードパーティの Web サービスで使用されていたものと同じ名前を使用することも、変更することもできます。名前を変更するには、名前の上にカーソルを合わせて編集ボタン をクリックします。

デフォルト値

フィールドのデフォルト値を指定する場合は、このチェックボックスをオンにします。チェックボックスをオンにした後に表示されるフィールドにデフォルト値を入力します。

フローからオーバーライドできないデフォルト値を指定するには、[デフォルト値] 列のチェックボックスをオンにして、[要求] 列の対応するボックスをオフにします。これによって、外部の Web サービスへの要求でデフォルト値を指定する場合に、フローにおいてそのフィールドは非表示となります。要求ごとに指定する必要のあるアクセス キーがある場合は、これが便利です。例:

スキーマのアップロード

POST または PUT 操作で Web サービスに送信するデータの構造を定義する XML スキーマを用意している場合は、このオプションを選択します。このオプションを選択した後、スキーマ ファイルの場所を参照して指定します。

サンプルの提供

POST または PUT 操作で Web サービスに送信するデータのサンプルを用意している場合は、このオプションを選択します。このオプションを選択した後、手動でサンプルを入力するか、ウィンドウにサンプルをペーストします。

スキーマかサンプルを提供したら、フロー ステージで利用可能にする各データ要素の隣にあるボックスをチェックします。

サンプル データを入力する際は、次の点に注意してください。

• すべてのフィールドにデータを入力する必要はありません。フィールドを空のままにすると、空の文字列がプレビューに使用されます。
• フィールドにデフォルト値または null 値を引き渡した場合の影響をプレビューしたい場合は、フィールドの横にある無効アイコン
  
  をクリックします。[要求] タブでフィールドのデフォルト値を定義した場合は、デフォルト値が使用されます。デフォルト値を定義しなかった場合は、null 値が使用されます。
• 複数のレコードを同時にプレビューできます。レコードを追加するには、追加ボタン をクリックします。
• テスト用のデータはファイルからインポートできます。データをインポートするには、インポート ボタン をクリックします。次のことに注意してください。
  • ファイルの最初の行は、ヘッダー レコードでなければなりません。ヘッダー内のフィールド名は、サービスで必要とされるフィールド名と一致する必要があります。
  • インポートできるレコードは、最大 5 個です。
  • フィールドの区切り文字がスペースの場合、フィールド値を引用符で囲む必要があります。スペースをフィールドの区切り文字に使うファイルの例を以下に示します。

    AddressLine1 AddressLine2 City StateProvince PostalCode
    "One Global View" "" "Troy" "NY" "12180"
    "3001 Summer St" "" "Stamford" "CT" "06926"
    "224 N Michigan Ave" "Suite 300" "Chicago" "IL" ""

• すべてのレコードを削除するには、プレビュー エリアの上部にある [削除] ボタン
  
  をクリックします。
• 特定のレコードを削除するには、入力レコード名 ("Input Record 1" など) の上にカーソルを合わせてレコード名の横の [削除] ボタン
  
  をクリックします。