Cloud Software Group, Inc. EBX®
ドキュメント>開発者ガイド> SOAPデータサービス
ナビゲーションモードドキュメント>開発者ガイド> SOAPデータサービス

WSDL生成

サポートされている標準仕様

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®は次の方法をサポートしています。

WSDLは、許可されたプロファイルによってのみダウンロードできます。

操作タイプ

アクセス権のアクセス許可

custom

少なくとも1つのWebサービスが登録されている場合は、すべてのプロファイル。

dataset

すべてのプロファイル。

directory

次の条件が有効な場合のすべてのプロファイル:

  • 特定のディレクトリ実装は使用されません。 (ビルトインの管理者ロールは、この条件の対象となるだけです)。

  • 管理用にグローバルアクセス許可が定義されています。

  • 「ディレクトリ」データセットのアクセス許可には、現在のプロファイルへの書き込みアクセス権があります。

repository

すべてのプロファイル。

tables

すべてのプロファイル。

userInterface

バージョン5.8.1以降非推奨。この操作タイプは、administrationに置き換えられました。下位互換性の理由から、ユーザーインターフェイス管理操作は引き続き使用できますが、このタイプは使用しないことをお勧めします。

すべての条件が有効な場合は、ビルトインの管理者ロールまたは委任された管理者プロファイル:

  • 管理用にグローバルアクセス許可が定義されています。

  • 「ユーザーインターフェイス」データセットのアクセス許可には、現在のプロファイルへの書き込みアクセス権があります。

administration

すべての条件が有効な場合は、ビルトインの管理者ロールまたは委任された管理者プロファイル:

  • 管理用にグローバルアクセス許可が定義されています。

  • 「管理」データセットのアクセス許可には、現在のプロファイルへの書き込みアクセス権があります。

workflow

すべてのプロファイル。

ユーザーインターフェイスからのWSDLダウンロード

許可されたユーザーは、データサービス管理領域からEBX®WSDLをダウンロードできます。

注意

詳細については、ユーザーガイドのデータスペース操作用のWSDLの生成を参照してください。

HTTPプロトコルからのWSDLダウンロード

アプリケーションは、GETまたはPOST HTTPメソッドを使用してEBX®WSDLをダウンロードできます。アプリケーションは、適切な権限を持つプロファイルを使用して認証される必要があります。

URL形式

http[s]://<host>[:<port>]/<ebx-dataservices>/{type}[/{dataspace}[/{dataset}]]?{queryParameters}

説明:

パラメーター

リクエストパラメーターは、次のいずれかの方法で指定できます。

パラメーター名

PathParam

QueryParam

必須

説明

WSDL

いいえ

はい

はい

WSDLダウンロード操作を指定します。

空の値。

login

いいえ

はい

いいえ

ユーザーIDを指定します。

標準の認証方法を使用する場合に必要です。

文字列型の値。

password

いいえ

はい

いいえ

ユーザーパスワードを指定します。

標準の認証方法を使用する場合に必要です。

文字列型の値。

type

はい

いいえ

はい

操作タイプを指定します。

可能な値は次のとおりです。customdatasetdirectoryadministrationuserInterfacerepositorytablesまたはworkflow

文字列型の値。

branch

version

はい

はい

(*)

データスペースまたはスナップショット識別子を指定します。

(*)tablesおよびdatasetタイプに必要です。それ以外の場合は無視されます。

文字列型の値。

instance

はい

はい

(*)

データセット名を指定します。

文字列型の値。

tablePaths

いいえ

はい

いいえ

テーブルパスのリストを指定します。

tablesまたはdirectoryタイプの場合はオプション。それ以外の場合は無視されます。

定義されていない場合、すべてのテーブルが選択されます。

各テーブルパスはカンマ文字で区切られます。

文字列型の値。

operations

いいえ

はい

いいえ

操作サブセットのWSDLを生成できます。

tablesまたはdirectoryの操作タイプではオプションです。それ以外の場合は無視されます。定義されていない場合、指定されたタイプのすべての操作が生成されます。

このパラメーターの値は、次の1つ以上の文字を連結したものです。

  • C =レコードをカウント

  • D =レコードを削除

  • E =認証情報を取得

  • G =変更を取得

  • I =レコードを挿入

  • U =レコードを更新

  • R =読み取り操作(CEGSと同等)

  • S =レコードを選択

  • W =書き込み操作(DIUと同等)

文字列型の値。

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)

リクエストが正しくありません。これは次の場合に発生します。

  • リクエストエレメントが正しくありません。

  • テーブル名の単一性チェックには、少なくとも1つのエラーが含まれています。

    注意

    詳細については、WSDLとテーブル操作を参照してください。

401 (Unauthorized)

リクエストには認証されたユーザーが必要です。

403 (Forbidden)

認証されたユーザーに対する要求は許可されていません。

405 (Method not allowed)

この構成ではリクエストは許可されていません。

500 (Internal error)

リクエストはエラーを生成します(スタックトレースと詳細なエラーメッセージが返されます)。

レスポンス本文

応答本文は、返されるステータスコードと要求されたWSDLコンテンツによって異なります。

HTTPの例

次の例の一部は、PathParamQueryParamの2つのメソッドで表示されます。

ドキュメント>開発者ガイド> SOAPデータサービス