構成Webサービスについて

構成Webサービスは、Oracle Endeca Serverの構成とレコード・スキーマ両方との人間工学的なやり取りを可能にするインタフェースを提供します。

概要

構成Webサービスでは、スキーマと構成を操作できます。他のパッケージ化されたWebサービスと同様に、サービスは、http://<host>:<port>/endeca-server/ws/config/<dataDomain>?wsdlでアクセスできるWSDLドキュメントで宣言されます。ホストとポートはOracle Endeca Serverを表し、dataDomainは、サーバーで作成されたデータ・ドメインの名前になります。

操作の説明

構成Webサービスへのリクエストは、構成とスキーマを読み込んで更新も行う一連の操作を含むconfigTransaction要素から構成されます。操作は単一のサービス・リクエストに任意に結合でき、各操作が最大1回出現できます。操作は、PDR (Property Description Record)、DDR (Dimension Description Record)、グループ、GCR (Global Configuration Record)およびXML構成ドキュメントに対してアクションを実行します。

put操作を含む構成Webサービス・リクエストの効果は、指定されたEndecaデータ・ドメインへの属性、XML構成ドキュメントまたはグローバル構成レコードの追加です。
  • 指定したキーを持つレコードがデータ・ドメインにすでに存在する場合は、それが置換されます。
  • レコードが存在しない場合は作成されます。

リクエスト

構成Webサービスへの入力は、使用される操作によって決まります。属性スキーマ・レコード(PDRとDDR)、Global Configuration Record、グループおよび一連のXML構成ドキュメントを含めることができます。

構成Webサービスに対するリクエストには、外部トランザクションのIDを指定するオプション要素のOuterTransactionIdを含めることができます(トランザクションがトランザクションWebサービスによって開始されている場合)。次の文で、構成リクエストと外部トランザクションのやり取りを説明します。
  • 外部トランザクションがトランザクションWebサービスによって開始された場合、構成リクエストはトランザクション内部のデータ・ファイルの最新バージョンまたはデータ・ファイルのトランザクション前のバージョンに対して実行できます。
    • 最新バージョンに対して構成リクエストを実行するには、リクエスト内のOuterTransactionId要素で、トランザクションの開始時にトランザクションWebサービスが発行したIDを指定する必要があります。この要素は、リクエストで最初に指定する要素である必要があります。
    • 発行済バージョン(外部トランザクションより前に発行されたバージョン、または外部トランザクションがコミットまたはロールバックされた後に発行されたバージョン)に対して実行するには、OuterTransactionId要素を空にするか省略する必要があります。

外部トランザクションが進行中でないときに外部トランザクションIDを指定することは正しくありません。外部トランザクションIDが間違って指定されたすべての構成リクエストはSOAPフォルトで失敗します。

レスポンス

構成Webサービスのすべての操作がデータを返すわけではありません。

操作でデータが返される場合、構成Webサービスへのレスポンスは結果要素であり、送信された各操作によって、固有の結果を示す要素がその中に生成されます。

いずれかの操作が成功しない場合は、Webサービス・トランザクション全体がSOAPフォルトを返し、操作はどれも適用されません。外部トランザクションがトランザクションWebサービスで開始され、構成Webサービスに送信されたリクエストに間違ったIDが指定されていた場合、操作は成功しないことがあります。

次の構成Webサービス・リクエストの例は、属性グループのリストを検索するために使用されます。
<config:configTransaction>
   xmlns:config="http://www.endeca.com/MDEX/config/services/types/2/0"
   xmlns:mdex="http://www.endeca.com/MDEX/config/XQuery/2009/09">
<config:listGroups/>
</config:configTransaction>