WSDL生成
Related information
サポートされている標準仕様
TIBCO EBX®は、W3C Webサービス記述言語 1.1標準に準拠するWSDLを生成します。
操作の種類
WSDLは、さまざまなタイプの操作に対して生成できます。
|
操作タイプ
|
WSDLの説明
|
|---|---|
custom
|
EBX®アドオンのWSDL。
|
dataset
|
データセットおよびレプリケーション操作用のWSDL。
|
directory
|
デフォルトのEBX®ディレクトリ操作用のWSDL。 tablePathsまたはoperationsパラメーターを使用してデータをフィルタリングすることもできます。
|
repository
|
データスペースまたはスナップショット管理操作用のWSDL。
|
tables
|
特定のデータセットのテーブルに対する操作のWSDL。
|
userInterface
|
バージョン5.8.1以降非推奨。この操作タイプは、
administrationに置き換えられました。下位互換性の理由から、ユーザーインターフェイス管理操作は引き続き使用できますが、このタイプは使用しないことをお勧めします。
ユーザーインターフェイス管理操作用のWSDL（これらの操作には管理者のみがアクセスできます）。
|
administration
|
次のような管理操作用のWSDL：
これらの操作には、管理者のみがアクセスできます。
|
workflow
|
EBX®ワークフロー管理操作用のWSDL。
|
WSDLのダウンロード方法
EBX®は次の方法をサポートしています。
-
ユーザーインターフェイスから
-
HTTPプロトコルから
WSDLは、許可されたプロファイルによってのみダウンロードできます。
|
操作タイプ
|
アクセス権のアクセス許可
|
|---|---|
custom
|
少なくとも1つのWebサービスが登録されている場合は、すべてのプロファイル。
|
dataset
|
すべてのプロファイル。
|
directory
|
次の条件が有効な場合のすべてのプロファイル：
|
repository
|
すべてのプロファイル。
|
tables
|
すべてのプロファイル。
|
userInterface
|
バージョン5.8.1以降非推奨。この操作タイプは、
administrationに置き換えられました。下位互換性の理由から、ユーザーインターフェイス管理操作は引き続き使用できますが、このタイプは使用しないことをお勧めします。
すべての条件が有効な場合は、ビルトインの管理者ロールまたは委任された管理者プロファイル：
|
administration
|
すべての条件が有効な場合は、ビルトインの管理者ロールまたは委任された管理者プロファイル：
|
workflow
|
すべてのプロファイル。
|
ユーザーインターフェイスからのWSDLダウンロード
HTTPプロトコルからのWSDLダウンロード
アプリケーションは、
GETまたは POST HTTPメソッドを使用してEBX®WSDLをダウンロードできます。アプリケーションは、適切な権限を持つプロファイルを使用して認証される必要があります。
URL形式
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。
|
パラメーター名
|
PathParam
|
QueryParam
|
必須
|
説明
|
|---|---|---|---|---|
WSDL
|
いいえ
|
はい
|
はい
|
WSDLダウンロード操作を指定します。
空の値。
|
login
|
いいえ
|
はい
|
いいえ
|
ユーザーIDを指定します。
標準の認証方法を使用する場合に必要です。
文字列型の値。
|
password
|
いいえ
|
はい
|
いいえ
|
ユーザーパスワードを指定します。
標準の認証方法を使用する場合に必要です。
文字列型の値。
|
type
|
はい
|
いいえ
|
はい
|
操作タイプを指定します。
可能な値は次のとおりです。
custom、dataset、directory、administration、userInterface、repository、tablesまたはworkflow。
文字列型の値。
|
branch
version
|
はい
|
はい
|
（*）
|
データスペースまたはスナップショット識別子を指定します。
（*）
tablesおよびdatasetタイプに必要です。それ以外の場合は無視されます。
文字列型の値。
|
instance
|
はい
|
はい
|
（*）
|
データセット名を指定します。
文字列型の値。
|
tablePaths
|
いいえ
|
はい
|
いいえ
|
テーブルパスのリストを指定します。
tablesまたはdirectoryタイプの場合はオプション。それ以外の場合は無視されます。
定義されていない場合、すべてのテーブルが選択されます。
各テーブルパスはカンマ文字で区切られます。
文字列型の値。
|
operations
|
いいえ
|
はい
|
いいえ
|
操作サブセットのWSDLを生成できます。
tablesまたはdirectoryの操作タイプではオプションです。それ以外の場合は無視されます。定義されていない場合、指定されたタイプのすべての操作が生成されます。
このパラメーターの値は、次の1つ以上の文字を連結したものです。
文字列型の値。
|
namespaceURI
|
はい
|
はい
|
（**）
|
カスタムWebサービスの一意のネームスペースURIを指定します。
（**）
typeパラメーターがcustomに設定されている場合は必須であり、それ以外の場合は無視されます。
URI 型の値。
|
attachmentFilename
|
いいえ
|
はい
|
（***）
|
添付ファイル名を指定します。
（***）
isContentInAttachmentパラメーターが定義され、trueに設定されている場合はオプション、それ以外の場合は無視されます。
文字列型の値。
|
isContentInAttachment
|
いいえ
|
はい
|
いいえ
|
WSDLを添付ファイルとしてダウンロードするかどうかを指定します。
ブール値型の値。
デフォルト値は falseです。
|
targetNamespace
|
いいえ
|
はい
|
いいえ
|
WSDLのターゲットネームスペースURIをオーバーライドします。
URI 型の値。
デフォルト値は urn：ebx：ebx-dataservicesです。
|
メッセージ本文
メッセージ本文は必要ありません。
HTTPコード
HTTPコードが常に返されます。エラーは400を超えるコードで示されます。
|
ステータスコード
|
情報
|
|---|---|
200 (OK)
|
WSDLコンテンツは正常に生成され、リクエストによって返されます（オプションで添付ファイル）。
|
400 (Bad request)
|
リクエストが正しくありません。これは次の場合に発生します。
|
401 (Unauthorized)
|
リクエストには認証されたユーザーが必要です。
|
403 (Forbidden)
|
認証されたユーザーに対する要求は許可されていません。
|
405 (Method not allowed)
|
この構成ではリクエストは許可されていません。
|
500 (Internal error)
|
リクエストはエラーを生成します（スタックトレースと詳細なエラーメッセージが返されます）。
|
レスポンス本文
応答本文は、返されるステータスコードと要求された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に設定されます。
HTTPの例
次の例の一部は、
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'データセットのすべてのテーブル操作が含まれます。PathParamhttp[s]://<host>[:<port>]/<ebx-dataservices>/tables/dataspace1/dataset1?WSDLQueryParamhttp[s]://<host>[:<port>]/<ebx-dataservices>/tables?WSDL&branch=<dataspace1>&instance=<dataset1> -
WSDLには、
'dataspace1'データスペース内の'dataset1'データセットの読み取り操作のみを含むすべてのテーブルが含まれます。PathParamhttp[s]://<host>[:<port>]/<ebx-dataservices>/tables/dataspace1/dataset1?WSDL&operations=RQueryParamhttp[s]://<host>[:<port>]/<ebx-dataservices>/tables?WSDL&branch=dataspace1&instance=dataset1&operations=R -
WSDLには、
'dataspace1'データスペース内の'dataset1'データセットに対して選択された2つのテーブル操作が含まれます。PathParamhttp[s]://<host>[:<port>]/<ebx-dataservices>/tables/dataspace1/dataset1?WSDL&tablePaths=/root/table1,/root/table2QueryParamhttp[s]://<host>[:<port>]/<ebx-dataservices>/tables?WSDL&branch=dataspace1&instance=dataset1&tablePaths=/root/table1,/root/table2 -
WSDLには、専用URIのカスタムWebサービス操作が含まれます。
PathParamhttp[s]://<host>[:<port>]/<ebx-dataservices>/custom/urn:ebx-test:com.orchestranetworks.dataservices.WSDemo?WSDLQueryParamhttp[s]://<host>[:<port>]/<ebx-dataservices>/custom?WSDL&namespaceURI=urn:ebx-test:com.orchestranetworks.dataservices.WSDemo