Web サービスとしてのサービスのエクスポーズ

Spectrum™ Technology Platform サービスは、REST または SOAP Web サービスとして使用できます。サービスをサーバー上で Web サービスとして使用できるようにするには

  1. Enterprise Designer を開きます。
  2. Web サービスとしてエクスポーズするサービスを開きます。
  3. [編集] > [Web サービス オプション] の順に選択します。
  4. サービスを SOAP Web サービスとして使用できるようにするには、 [SOAP Web サービスとして公開]チェック ボックスをオンにします。
  5. サービスを REST Web サービスとして使用できるようにするには、 [REST Web サービスとして公開] チェック ボックスをオンにして、次の手順を実行します。
    1. デフォルトのエンドポイントをオーバーライドする場合は、使用するエンドポイントを [パス] フィールドに指定します。

      パスの指定はオプションです。REST Web サービスのデフォルトのエンドポイントは次のとおりです。

      http://server:port/rest/service_name/results.qualifier

      別のエンドポイントを使用する場合は、指定したパスがサービス名の後に追加されます。例えば、" Americas/Shipping " と [パス] フィールドに指定すると、JSON エンドポイントは次のようになります。

      http://myserver:8080/rest/MyService/Americas/Shipping/results.json

      [変数の挿入] ドロップダウンメニューをクリックして、使用するフィールドまたはオプションを選択することにより、データフローからのフィールドとオプションをパス内の変数名として使用できます。変数はパス内において、 ${Option.Name} (データフロー オプションの場合)、または ${Data.Name} (データフロー フィールドの場合) という表記で記述されます。

    2. REST Web サービスはデフォルトで、GET メソッドをサポートし、XML および JSON 形式でデータを返します。[追加] をクリックしてリソースを Web サービスに追加することによって、その他の HTTP メソッドや出力形式を定義できます。
      リソースを追加する際に、HTTP メソッド (GET または POST) を選択できます。サポートされるデータ形式は以下のとおりです。これらの形式のすべてが使用できるとは限りません。一部の形式は、お使いの Spectrum™ Technology Platform サーバー上に特定のモジュールがインストールされている場合のみ使用可能であるためです。
      XML
      デフォルトの XML 形式。XML をリクエストとレスポンスの形式として使用し、処理するデータに特殊な XML 形式が存在しない場合は、この形式を使用します。
      JSON
      デフォルトの JSON 形式。JSON をリクエストとレスポンスの形式として使用し、処理するデータに特殊な JSON 形式が存在しない場合は、この形式を使用します。
      GeoJSON
      地理的データを処理するサービスに適合した特殊な JSON 形式です。ジオメトリおよび次のネイティブ プラットフォーム 型でのみサポートされています。
      • boolean
      • double
      • float
      • integer
      • bigdecimal
      • long
      • string
      • date
      • time
      • datetime
      • timespan

      その他の型を持つフローをエクスポーズしようとする場合は、GeoJSON を指定できません (設計時にエラーが表示されます)。また、GeoJSON では単一ジオメトリのみを使用できます。出力に複数のジオメトリ フィールドが含まれている場合は、システムは "geometry" というフィールドに続いて "obj" というフィールドを検索します。そうしたフィールドが存在しない場合は、最初のジオメトリ フィールドが選択されます。

    3. [OK] をクリックします。

      新しいリソースが Web サービスに追加されます。

  6. Web サービス オプションの設定を終えたら、 [OK] をクリックします。
  7. ツール バーにあるグレーの電球をクリックして、サービスをエクスポーズします。

    データフローがエクスポーズされると、次のように、Enterprise Designer ツール バーの電球ボタンがデータフローのエクスポーズを示します。

サービスが Web サービスとしてエクスポーズされているか確認するには、以下のいずれかの URL に移動します。
  • REST の場合: http://server:port/rest
  • SOAP の場合: http://server:port/soap

ここで、server は Spectrum™ Technology Platform サーバーの名前または IP アドレス、port は HTTP 通信に使用するポート番号です。