TIBCO EBX®は、W3C Webサービス記述言語 1.1標準に準拠するWSDLを生成します。
WSDLは、さまざまなタイプの操作に対して生成できます。
操作タイプ | WSDLの説明 |
---|---|
| EBX®アドオンのWSDL。 |
| データセットおよびレプリケーション操作用のWSDL。 |
| デフォルトのEBX®ディレクトリ操作用のWSDL。 |
| データスペースまたはスナップショット管理操作用のWSDL。 |
| 特定のデータセットのテーブルに対する操作のWSDL。 |
| バージョン5.8.1以降非推奨。この操作タイプは、 ユーザーインターフェイス管理操作用のWSDL(これらの操作には管理者のみがアクセスできます)。 |
| 次のような管理操作用のWSDL:
これらの操作には、管理者のみがアクセスできます。 |
| EBX®ワークフロー管理操作用のWSDL。 |
EBX®は次の方法をサポートしています。
ユーザーインターフェイスから
HTTPプロトコルから
WSDLは、許可されたプロファイルによってのみダウンロードできます。
操作タイプ | アクセス権のアクセス許可 |
---|---|
| 少なくとも1つのWebサービスが登録されている場合は、すべてのプロファイル。 |
| すべてのプロファイル。 |
| 次の条件が有効な場合のすべてのプロファイル:
|
| すべてのプロファイル。 |
| すべてのプロファイル。 |
| バージョン5.8.1以降非推奨。この操作タイプは、 すべての条件が有効な場合は、ビルトインの管理者ロールまたは委任された管理者プロファイル:
|
| すべての条件が有効な場合は、ビルトインの管理者ロールまたは委任された管理者プロファイル:
|
| すべてのプロファイル。 |
許可されたユーザーは、データサービス管理領域からEBX®WSDLをダウンロードできます。
詳細については、ユーザーガイドのデータスペース操作用のWSDLの生成を参照してください。
アプリケーションは、GET
またはPOST
HTTPメソッドを使用してEBX®WSDLをダウンロードできます。アプリケーションは、適切な権限を持つプロファイルを使用して認証される必要があります。
http[s]://<host>[:<port>]/<ebx-dataservices>/{type}[/{dataspace}[/{dataset}]]?{queryParameters}
説明:
<ebx-dataservices>
は、「ebx-dataservices.war」Webアプリケーションのパスに対応します。パスは、複数のURIセグメント、またはWebアプリケーションの名前が続くURIセグメントで構成されます。
{type}
は、操作タイプに対応します。
{dataspace}
は、データスペースまたはスナップショット識別子に対応します。
{dataset}
はデータセット名に対応します。
{queryParameters}
は、URLを介して渡される共通または専用の操作パラメーターに対応します。
リクエストパラメーターは、次のいずれかの方法で指定できます。
URLからのパスセグメントに対応するPathParam
(推奨)
値を持つ標準のHTTPパラメーターに対応するQueryParam
。
パラメーター名 |
|
| 必須 | 説明 |
---|---|---|---|---|
| いいえ | はい | はい | WSDLダウンロード操作を指定します。 空の値。 |
| いいえ | はい | いいえ | ユーザーIDを指定します。 標準の認証方法を使用する場合に必要です。
|
| いいえ | はい | いいえ | ユーザーパスワードを指定します。 標準の認証方法を使用する場合に必要です。
|
| はい | いいえ | はい | 操作タイプを指定します。 可能な値は次のとおりです。
|
| はい | はい | (*) | データスペースまたはスナップショット識別子を指定します。 (*)
|
| はい | はい | (*) | データセット名を指定します。
|
| いいえ | はい | いいえ | テーブルパスのリストを指定します。
定義されていない場合、すべてのテーブルが選択されます。 各テーブルパスはカンマ文字で区切られます。
|
| いいえ | はい | いいえ | 操作サブセットのWSDLを生成できます。
このパラメーターの値は、次の1つ以上の文字を連結したものです。
|
| はい | はい | (**) | カスタムWebサービスの一意のネームスペースURIを指定します。 (**)
|
| いいえ | はい | (***) | 添付ファイル名を指定します。 (***)
|
| いいえ | はい | いいえ | WSDLを添付ファイルとしてダウンロードするかどうかを指定します。
デフォルト値は |
| いいえ | はい | いいえ | WSDLのターゲットネームスペースURIをオーバーライドします。
デフォルト値は |
メッセージ本文は必要ありません。
HTTPコードが常に返されます。エラーは400を超えるコードで示されます。
ステータスコード | 情報 |
---|---|
| WSDLコンテンツは正常に生成され、リクエストによって返されます(オプションで添付ファイル)。 |
| リクエストが正しくありません。これは次の場合に発生します。
|
| リクエストには認証されたユーザーが必要です。 |
| 認証されたユーザーに対する要求は許可されていません。 |
| この構成ではリクエストは許可されていません。 |
| リクエストはエラーを生成します(スタックトレースと詳細なエラーメッセージが返されます)。 |
応答本文は、返されるステータスコードと要求されたWSDLコンテンツによって異なります。
200
(OK):HTTPヘッダーの Content-Type
が text/xml;charset=UTF-8
に設定されています。
コンテンツが添付ファイルにある場合、HTTPヘッダーContent-Disposition
は添付ファイルfilename*=UTF-8''<filename.wsdl>
に対して設定されます。
4xx
:詳細なメッセージが本文に返されます。 HTTPヘッダーContent-Type
はtext/html;charset=utf-8
に設定されます。
次の例の一部は、PathParam
とQueryParam
の2つのメソッドで表示されます。
WSDLには、標準の認証方法を使用したすべてのリポジトリ操作が含まれます。
http[s]://<host>[:<port>]/<ebx-dataservices>/repository?WSDL&login=<login>&password=<password>
WSDLには、すべてのワークフロー操作が含まれます。
http[s]://<host>[:<port>]/<ebx-dataservices>/workflow?WSDL
WSDLには、'dataspace1'
データスペース内の'dataset1'
データセットのすべてのテーブル操作が含まれます。
PathParam
http[s]://<host>[:<port>]/<ebx-dataservices>/tables/dataspace1/dataset1?WSDL
QueryParam
http[s]://<host>[:<port>]/<ebx-dataservices>/tables?WSDL&branch=<dataspace1>&instance=<dataset1>
WSDLには、'dataspace1'
データスペース内の'dataset1'
データセットの読み取り操作のみを含むすべてのテーブルが含まれます。
PathParam
http[s]://<host>[:<port>]/<ebx-dataservices>/tables/dataspace1/dataset1?WSDL&operations=R
QueryParam
http[s]://<host>[:<port>]/<ebx-dataservices>/tables?WSDL&branch=dataspace1&instance=dataset1&operations=R
WSDLには、'dataspace1'
データスペース内の'dataset1'
データセットに対して選択された2つのテーブル操作が含まれます。
PathParam
http[s]://<host>[:<port>]/<ebx-dataservices>/tables/dataspace1/dataset1?WSDL&tablePaths=/root/table1,/root/table2
QueryParam
http[s]://<host>[:<port>]/<ebx-dataservices>/tables?WSDL&branch=dataspace1&instance=dataset1&tablePaths=/root/table1,/root/table2
WSDLには、専用URIのカスタムWebサービス操作が含まれます。
PathParam
http[s]://<host>[:<port>]/<ebx-dataservices>/custom/urn:ebx-test:com.orchestranetworks.dataservices.WSDemo?WSDL
QueryParam
http[s]://<host>[:<port>]/<ebx-dataservices>/custom?WSDL&namespaceURI=urn:ebx-test:com.orchestranetworks.dataservices.WSDemo