SOAP操作

最終公開日 : Sep 16, 2026
Related information

データモデルから生成された操作

TIBCO EBX®リポジトリで使用されるデータモデルの場合、その操作を定義する対応するWSDLを動的に生成できます。このWSDLを使用すると、EBX®リポジトリの読み取り/書き込みが可能になります。たとえば、パス/root/XX/exampleTableにあるテーブルの場合、生成されるリクエストは基になるデータモデルの構造に従い、テーブル名<m:{operation}_exampleTable xmlns:m="urn:ebx-schemas:dataservices_1.0">を含みます。
注意:
WSDLおよびSOAP操作はデータモデル構造に密接に依存しているため、データモデルを変更した後は、最新のWSDLを再配布することが重要です。

コンテンツポリシー

レコードのコンテンツへのアクセス、XML 要素の有無は、認証されたユーザー セッションの 解決された権限 によって異なります。以下に詳述する追加の側面がコンテンツに影響を与える可能性があります。

データモデルからのフィールドの無効化

データモデルで定義されている hiddenInDataServicesプロパティを使用すると、ユーザープロファイルに関係なく、データサービスのフィールドを常に非表示にできます。このパラメーターは、生成されたWSDLに影響を与えます。非表示のフィールドまたはグループは、要求および応答の構造に含まれません。
hiddenInDataServicesパラメータ値を変更すると、以前のWSDLを引き続き使用するクライアントに次の影響があります。
  • リクエストに応じて、データモデルプロパティが trueに変更され、関連するフィールドがWSDLリクエストに存在する場合、例外がスローされます。
  • 応答時に、スキーマプロパティが falseに変更されている場合、WSDL検証がアクティブ化されると、エラーが返されます。
この「デフォルトビュー」の設定は、データモデル内で定義されています。
も参照してください:

関連付けフィールド

テーブルレコードへの読み取りアクセスにより、UIManagerに表示される関連付けフィールドをエクスポートできます。この機能は、「hiddenInDataServices」モデルパラメーターと組み合わせることができます。
注:
制限事項：変更および更新操作では、関連付けフィールドは管理されません。また、select操作は、第1レベルの関連付け要素のみをエクスポートします（関連付けられたオブジェクトのコンテンツに関連付け要素を含めることはできません）。

一般的なリクエストパラメータ

いくつかのパラメータはいくつかの操作に共通であり、以下で詳しく説明します。
要素
説明
必須
ブランチ
データセットが属するデータスペースの識別子。
このパラメーターまたは「バージョン」パラメーターのいずれかを定義する必要があります。 '挿入'、 '更新'、および '削除'操作に必要です。
version
データセットが属するスナップショットの識別子。
このパラメーターまたは「ブランチ」パラメーターのいずれかを定義する必要があります
実例
クエリするテーブルを含むデータセットの一意の名前。
はい
述語
XPath述語は、リクエストが適用されるレコードを定義します。空の場合、このフィールドが必須である「削除」操作を除いて、すべてのレコードが取得されます。
も参照してください:
'削除'操作にのみ必要
データ
データモデルの構造内で表される、変更されるレコードが含まれます。操作全体は、XMLインポートと同等です。データコンテンツに対して実行される操作の詳細は、セクションインポートで指定されています。
挿入および更新操作にのみ必要です
viewPublication
このパラメーターは、論理的なAND操作としてpredicateパラメーターと組み合わせることができます。
このパラメーターの動作については、Web コンポーネントとしての EBX® セクションに説明が記載されています。
「viewId」パラメーターが使用されている場合は使用できず、階層ビューまたはタイルビューでは使用できません。
番号
viewId
バージョン5.2.3以降非推奨。このパラメーターは、パラメーター 'viewPublication'に置き換えられました。下位互換性のために利用可能なままですが、将来のバージョンで最終的に削除される予定です。
'viewPublication'パラメーターが使用されている場合、このパラメーターは使用できません。
番号
blockingConstraintsDisabled
このプロパティは、すべてのテーブル更新データサービス操作で使用できます。
trueの場合、検証プロセスはデータモデルで定義されたブロッキング制約を無効にします。
このパラメータが存在しない場合、デフォルトはfalseです。
詳細については、ブロッキング制約と非ブロッキング制約を参照してください。
番号
詳細
details要素は、次のオプションを指定します。
オプションの属性locale（デフォルトは 'en-US'）は、検証メッセージを返す必要があるblockingConstraintsDisabledパラメーターの言語を定義します。
番号
最後のブロードキャストへのリダイレクトを無効にする
このプロパティは、すべてのデータ サービス操作で使用できます。
trueの場合、D3 プライマリ ノード上の配信データスペースへのアクセスは、最後のブロードキャスト スナップショットにリダイレクトされません。それ以外の場合、そのようなデータスペースへのアクセスは常に最後のスナップショット ブロードキャストにリダイレクトされます。
このパラメータが存在しない場合は、構成プロパティ ebx.dataservices.disableRedirectionToLastBroadcast.default が設定されていない限り、デフォルトは false (D3 マスターでのリダイレクトが有効)になります。
指定されたデータスペースが D3 プライマリ ノード上の配信データスペースでない場合、このパラメーターは無視されます。
番号

操作の選択

テーブルでリクエストを選択

<m:select_{TableName} xmlns:m="urn:ebx-schemas:dataservices_1.0">
    <branch>String</branch>
    <version>String</version>
    <instance>String</instance>
    <predicate>String</predicate>
    <includesMetadata>String</includesMetadata>
    <viewPublication>String</viewPublication>
    <exportCredentials>boolean</exportCredentials>
    <pagination>
        <previousPageLastRecordPredicate>String</previousPageLastRecordPredicate>
        <pageSize>Integer</pageSize>
    </pagination>
    <disableRedirectionToLastBroadcast>boolean</disableRedirectionToLastBroadcast>
</m:select_{TableName}>
と：
要素
説明
必須
ブランチ
共通パラメータの説明を参照してください。
version
共通パラメータの説明を参照してください。
実例
共通パラメータの説明を参照してください。
述語
共通パラメータの説明を参照してください。
このパラメーターは、論理的なAND操作としてviewPublicationパラメーターと組み合わせることができます。
viewPublication
共通パラメータの説明を参照してください。
includesMetadata
応答には、指定されたメタデータが含まれています。返された各レコードには、ebx-metadata ルートエレメントの下にステップと呼ばれる追加エレメントが含まれています。
たとえば、「system」ステップ値には技術データが含まれます。楽観ロックセクションも参照してください。 
<system>

  <uuid>7FE03810-6A67-11ED-A892-00FF20216100</uuid>

  <creator>Uadmin</creator>

  <creation_time>2022-11-12T00:07:40.858</creation_time>

  <updater>Uadmin</updater>

  <update_time>2022-11-12T00:07:40.831</update_time>

</system>
文字列値のステップ (デフォルト値は空) はカンマで区切る必要があります (system, teamUp)。 ebx-all 値を使用して、すべてのステップを返すことができます。
番号
includesTechnicalData
バージョン 6.1.0 以降非推奨。includesMetadata リクエストパラメーターに置き換えられました。 true の場合、レスポンスには技術データが含まれます。楽観ロックセクションも参照してください。
返される各レコードには、この技術情報の追加の属性が含まれます。次に例を示します。 
...<table

ebxd:lastTime="2010-06-28T10:10:31.046" ebxd:lastUser="Uadmin"

ebxd:uuid="9E7D0530-828C-11DF-B733-0012D01B6E76">... .
番号
exportCredentials
trueの場合、selectは各レコードのクレデンシャルも返します。
番号
ページ付け
ページネーション構成を指定します。以下の子要素を参照してください。
番号
pageSize（pagination要素の下にネストされています）
1ページあたりのレコードの最大数を指定します。
整数タイプ。デフォルト値は10です。
も参照してください:
値 0 は、推奨される最大ページサイズを選択します。デフォルトは 10000 です。
も参照してください:
注:
指定またはデフォルトのページサイズ値が推奨される最大ページサイズを超える場合は、最大ページサイズが使用されます。
番号
previousPageLastRecordPredicate（ページ付け要素の下にネストされています）
ページ付けが有効になっている場合、ページをフェッチする必要があるレコードを定義するXPath述語。この値は、前の応答によって要素lastRecordPredicateとして提供されます。渡されたレコードが見つからない場合は、最初のページが返されます。
番号
最後のブロードキャストへのリダイレクトを無効にする
共通パラメータの説明を参照してください。

テーブルで応答を選択します

<ns1:select_{TableName}Response xmlns:ns1="urn:ebx-schemas:dataservices_1.0">
    <data>
        <XX>
            <TableName>
                <a>key1</a>
                <b>valueb</b>
                <c>1</c>
                <d>1</d>
            </TableName>
        </XX>
    </data>
    <credentials>
        <XX>
            <TableName predicate="./a='key1'">
                <a>W</a>
                <b>W</b>
                <c>W</c>
                <d>W</d>
            </TableName>
        </XX>
    </credentials>
    <lastRecordPredicate>./a='key1'</lastRecordPredicate>
</ns1:select_{TableName}Response>
と：
要素 説明
データ テーブルパスの後に表示されるレコードのコンテンツ。
資格情報 各レコードの各ノードのアクセス権が含まれています。
lastRecordPredicate ページネーションが有効になっている場合にのみ返されます。これは、要素 previousPageLastRecordPredicatedの次のリクエストで使用される最後のレコードを定義します。
オプティミスティックロックセクションも参照してください。

データセットでリクエストを選択

この操作は、テーブルなしのデータセットコンテンツを返します。
<m:selectInstance xmlns:m="urn:ebx-schemas:dataservices_1.0">
    <branch>String</branch>
    <version>String</version>
    <instance>String</instance>
</m:selectInstance>
と：
要素 説明 必須
ブランチ 共通パラメータの説明を参照してください。
version 共通パラメータの説明を参照してください。
実例 共通パラメータの説明を参照してください。
最後のブロードキャストへのリダイレクトを無効にする 共通パラメータの説明を参照してください。

データセットの応答を選択

<ns1:selectInstanceResponse xmlns:ns1="urn:ebx-schemas:dataservices_1.0">
    <data>
        <settings>
            <XX>
                <a>key1</a>
                <b>valueb</b>
                <c>1</c>
                <d>true</d>
            </XX>
        </settings>
    </data>
</ns1:selectInstanceResponse>
と：
要素 説明
データ テーブルのないデータセットコンテンツ。

削除操作

レコードを削除するか、子データセットの場合は、レコードのコンテキストに応じてレコードの状態を「隠蔽」または「継承」として定義します。レコードは、predicateパラメーターによって選択されます。

リクエストの削除

<m:delete_{TableName} xmlns:m="urn:ebx-schemas:dataservices_1.0">
    <branch>String</branch>
    <instance>String</instance>
    <predicate>String</predicate>
    <includeOcculting>boolean</includeOcculting>
    <inheritIfInOccultingMode>boolean</inheritIfInOccultingMode>
    <checkNotChangedSinceLastTime>dateTime</checkNotChangedSinceLastTime>
    <blockingConstraintsDisabled>boolean</blockingConstraintsDisabled>
    <details locale="Locale"/>
    <disableRedirectionToLastBroadcast>Boolean</disableRedirectionToLastBroadcast>
</m:delete_{TableName}>
と：
要素 説明 必須
ブランチ 共通パラメータの説明を参照してください。
実例 共通パラメータの説明を参照してください。
述語 共通パラメータの説明を参照してください。
インクルードオカルティング オカルティングモードのレコードが含まれます。 デフォルト値は falseです。 番号
継承IfInOccultingMode オカルティングモードの場合、親からレコードを継承します。 デフォルト値は falseです。 番号
occultIfInherit バージョン5.7.0以降非推奨レコードが継承モードの場合、レコードを非推奨にします。 デフォルト値は falseです。 番号
checkNotChangedSinceLastTime タイムスタンプは、最後の読み取り以降にレコードが変更されていないことを確認するために使用されます。 オプティミスティックロックセクションも参照してください。 番号
blockingConstraintsDisabled 共通パラメータの説明を参照してください。
詳細 共通パラメータの説明を参照してください。
最後のブロードキャストへのリダイレクトを無効にする 共通パラメータの説明を参照してください。

応答を削除

提供されたパラメーターの1つが不正である場合、必須パラメーターが欠落している場合、アクションが許可されていない場合、またはレコードが選択されていない場合は、例外が返されます。それ以外の場合は、特定の応答が返されます。
<ns1:delete_{TableName}Response xmlns:ns1="urn:ebx-schemas:dataservices_1.0">
    <status>String</status>
    <blockingConstraintMessage>String</blockingConstraintMessage>
</ns1:delete_{TableName}Response>
と：
要素 説明
status 「00」は、操作が正常に実行されたことを示します。 「95」は、少なくとも1つの操作がブロック制約に違反し、その結果、操作全体が中止されたことを示します。
blockingConstraintMessage この要素は、ローカライズされたメッセージでステータスが「95」に等しい場合に存在します。メッセージのロケールは、要求パラメーターまたはユーザーセッションから取得されます。

カウント操作

カウントリクエスト

<m:count_{TableName} xmlns:m="urn:ebx-schemas:dataservices_1.0">
    <branch>String</branch>
    <version>String</version>
    <instance>String</instance>
    <predicate>String</predicate>
    <disableRedirectionToLastBroadcast>boolean</disableRedirectionToLastBroadcast>
</m:count_{TableName}>
と：
要素 説明
ブランチ 共通パラメータの説明を参照してください。
version 共通パラメータの説明を参照してください。
実例 共通パラメータの説明を参照してください。
述語 共通パラメータの説明を参照してください。
最後のブロードキャストへのリダイレクトを無効にする 共通パラメータの説明を参照してください。

応答をカウント

<ns1:count_{TableName}Response xmlns:ns1="urn:ebx-schemas:dataservices_1.0">
    <count>Integer</count>
</ns1:count_{TableName}Response>
と：
要素 説明
count 要求内の述部に対応するレコードの数。

更新操作

更新リクエスト

<m:update_{TableName} xmlns:m="urn:ebx-schemas:dataservices_1.0">
    <branch>String</branch>
    <instance>String</instance>
    <updateOrInsert>boolean</updateOrInsert>
    <byDelta>boolean</byDelta>
    <blockingConstraintsDisabled>boolean</blockingConstraintsDisabled>
    <details locale="Locale"/>
    <disableRedirectionToLastBroadcast>boolean</disableRedirectionToLastBroadcast>
    <data>
        <XX>
            <TableName>
                <a>String</a>
                <b>String</b>
                <c>String</c>
                <d>String</d>
                ...
            </TableName>
        </XX>
    </data>
</m:update_{TableName}>
と：
要素 説明 必須
ブランチ 共通パラメータの説明を参照してください。
実例 共通パラメータの説明を参照してください。
updateOrInsert trueでレコードが現在存在しない場合、操作によってレコードが作成されます。 booleanタイプ。デフォルト値は falseです。 番号
byDelta trueであり、受信メッセージに要素が現在存在しない場合、ターゲット値は変更されません。 falseで、ノードが hiddenInDataServicesと宣言されている場合、ターゲット値は変更されません。 完全な動作については、挿入および更新操作のセクションで説明しています。 番号
blockingConstraintsDisabled 共通パラメータの説明を参照してください。
詳細 共通パラメータの説明を参照してください。
最後のブロードキャストへのリダイレクトを無効にする 共通パラメータの説明を参照してください。
データ 共通パラメータの説明を参照してください。
も参照してください:

応答を更新

<ns1:update_{TableName}Response xmlns:ns1="urn:ebx-schemas:dataservices_1.0">
    <status>String</status>
    <blockingConstraintMessage>String</blockingConstraintMessage>
</ns1:update_{TableName}Response>
と：
要素 説明
status 「00」は、操作が正常に実行されたことを示します。 「95」は、少なくとも1つの操作がブロック制約に違反し、その結果、操作全体が中止されたことを示します。
blockingConstraintMessage この要素は、ローカライズされたメッセージでステータスが「95」に等しい場合に存在します。メッセージのロケールは、要求パラメーターまたはユーザーセッションから取得されます。

挿入操作

リクエストを挿入

<m:insert_{TableName} xmlns:m="urn:ebx-schemas:dataservices_1.0">
    <branch>String</branch>
    <instance>String</instance>
    <byDelta>boolean</byDelta>
    <blockingConstraintsDisabled>boolean</blockingConstraintsDisabled>
    <details locale="Locale"/>
    <disableRedirectionToLastBroadcast>boolean</disableRedirectionToLastBroadcast>
    <data>
        <XX>
            <TableName>
                <a>String</a>
                <b>String</b>
                <c>String</c>
                <d>String</d>
                ...
            </TableName>
        </XX>
    </data>
</m:insert_{TableName}>
と：
要素 説明 必須
ブランチ 共通パラメータの説明を参照してください。
実例 共通パラメータの説明を参照してください。
byDelta trueであり、受信メッセージに要素が現在存在しない場合、ターゲット値は変更されません。 falseで、ノードが hiddenInDataServicesと宣言されている場合、ターゲット値は変更されません。 完全な動作については、挿入および更新操作のセクションで説明しています。 番号
blockingConstraintsDisabled 共通パラメータの説明を参照してください。
詳細 共通パラメータの説明を参照してください。
最後のブロードキャストへのリダイレクトを無効にする 共通パラメータの説明を参照してください。
データ 共通パラメータの説明を参照してください。

応答を挿入

<ns1:insert_{TableName}Response xmlns:ns1="urn:ebx-schemas:dataservices_1.0">
    <status>String</status>
    <blockingConstraintMessage>String</blockingConstraintMessage>
    <inserted>
        <predicate>./a='String'</predicate>
    </inserted>
</ns1:insert_{TableName}Response>
と：
要素 説明
status 「00」は、操作が正常に実行されたことを示します。 「95」は、少なくとも1つの操作がブロック制約に違反し、その結果、操作全体が中止されたことを示します。
blockingConstraintMessage この要素は、ローカライズされたメッセージでステータスが「95」に等しい場合に存在します。メッセージのロケールは、要求パラメーターまたはユーザーセッションから取得されます。
述語 挿入されたレコードの主キーに一致する述部。複数のレコードが挿入されると、述部は入力メッセージ内のレコードの宣言順序に従います。

変更操作を取得する

コンテンツポリシーに従って変更を返します。

変更リクエストを取得する

2つのデータセット間の変更：
<m:getChangesOnDataSet_{schemaName} xmlns:m="urn:ebx-schemas:dataservices_1.0">
    <branch>String</branch>
    <version>String</version>
    <instance>String</instance>
    <compareWithBranch>String</compareWithBranch>
    <compareWithVersion>String</compareWithVersion>
    <compareWithInstance>String</compareWithInstance>
    <resolvedMode>boolean</resolvedMode>
    <includeInstanceUpdates>boolean</includeInstanceUpdates>
</m:getChangesOnDataSet_{schemaName}>
2つのテーブル間の変更：
<m:getChanges_{TableName} xmlns:m="urn:ebx-schemas:dataservices_1.0">
    <branch>String</branch>
    <version>String</version>
    <instance>String</instance>
    <compareWithBranch>String</compareWithBranch>
    <compareWithVersion>String</compareWithVersion>
    <resolvedMode>boolean</resolvedMode>
    <pagination>
        <pageSize>Integer</pageSize>
    </pagination>
    <disableRedirectionToLastBroadcast>boolean</disableRedirectionToLastBroadcast>
</m:getChanges_{TableName}>
と：
要素 説明 必須
ブランチ 共通パラメータの説明を参照してください。
version 共通パラメータの説明を参照してください。
実例 共通パラメータの説明を参照してください。
compareWithBranch 比較するデータスペースの識別子。 このパラメーターまたは「compareWithVersion」パラメーターのいずれかを定義する必要があります。
compareWithVersion 比較するスナップショットの識別子。 このパラメーターまたは「compareWithBranch」パラメーターのいずれかを定義する必要があります。
compareWithInstance 比較するデータセットの識別子。未定義の場合は、instanceパラメータが使用されます。 番号
resolveMode 差が解決モードで計算されるかどうかを定義します。デフォルトは trueです。 詳細については、解決モードを参照してください。 番号
includeInstanceUpdates データセットのコンテンツ更新を含めるかどうかを定義します。デフォルトは falseです。 番号
ページ付け 操作 getChangesおよび getChangesOnDataSetのページ付けコンテキストを有効にします。 クライアントがページ付けコンテキストサイズを定義できるようにします。各ページには、最大サイズに応じて、テーブルの挿入、更新、および/または削除されたレコードのコレクションが含まれています。 変更の取得永続化コンテキストは、リクエストのページサイズパラメータに従って最初の呼び出しで構築されます。 ページネーション コンテキストは サーバー ファイル システム上 に保持され、最後のページまで、またはタイムアウトに達するまで次のページを呼び出すことができます。 作成の場合：pageSizeパラメーターを定義します。 次のステップ：前の応答の識別子を使用して context要素を定義します。 ページ付けを有効にします。以下の子要素を参照してください。 番号
pageSize（pagination要素の下にネストされています） 各ページのレコードの最大数を定義します。最小サイズは 50です。 いいえ（作成のみ）
context（ページ付け要素の下にネストされています） ページ付けコンテキストのコンテンツを定義します。 いいえ（次のみ）
identifier（context要素の下にネストされています） ページ付けコンテキスト識別子。 はい
最後のブロードキャストへのリダイレクトを無効にする 共通パラメータの説明を参照してください。
注:
compareWithBranchまたはcompareWithVersionパラメーターのいずれも指定されていない場合、親との比較が行われます。
  • 現在のデータスペースまたはスナップショットがデータスペースの場合、最初のスナップショットとの比較が行われます（データスペースで行われたすべての変更が含まれます）。
  • 現在のデータスペースまたはスナップショットがスナップショットの場合、その親データスペースとの比較が行われます（現在のスナップショットが作成されてから親データスペースで行われたすべての変更が含まれます）。
  • 現在のデータスペースが「参照」データスペースの場合、例外を返します。
も参照してください:

変更の応答を取得する

2 つのデータセット間の変更
<ns1:getChangesOnDataSet_{schemaName}Response xmlns:ns1="urn:ebx-schemas:dataservices_1.0">
    <updated>
        <changes>
            <path>... Path of changed terminal value ...</path>
            <path>...</path>
        </changes>
        <data>
            ... see the whole content of dataset values (without table) ...
        </data>
    </updated>
    <getChanges_{TableName1}>
        ... see the getChanges between tables response example ...
    </getChanges_{TableName1}>
    <getChanges_{TableName2}>
        ... see the getChanges between tables response example ...
    </getChanges_{TableName2}>
    ...
</ns1:getChangesOnDataSet_{schemaName}Response>
2 つのテーブル間の変更
<ns1:getChanges_{TableName}Response xmlns:ns1="urn:ebx-schemas:dataservices_1.0">
    <inserted>
        <XX>
            <TableName>
                <a>AVALUE3</a>
                <b>BVALUE3</b>
                <c>CVALUE3</c>
                <d>DVALUE3</d>
            </TableName>
        </XX>
    </inserted>
    <updated>
        <changes>
            <change predicate="./a='AVALUE2'">
                <path>/b</path>
                <path>/c</path>
            </change>
        </changes>
        <data>
            <XX>
                <TableName>
                    <a>AVALUE2</a>
                    <b>BVALUE2.1</b>
                    <c>CVALUE2.1</c>
                    <d>DVALUE2</d>
                </TableName>
            </XX>
        </data>
    </updated>
    <deleted>
        <predicate>./a='AVALUE1'</predicate>
    </deleted>
</ns1:getChanges_{TableName}Response>
と：
要素 説明 必須
挿入 選択肢 compareWithBranchまたは compareWithVersionから挿入されたレコードが含まれます。 挿入されたレコードのXMLエクスポートに対応するこの要素の下のコンテンツ。 番号
更新済み 更新されたレコードまたはデータセットのコンテンツが含まれます。 番号
changes (updated エレメント下にネスト) フィールドのグループのみが更新されました。 はい
change (changes エレメント下にネスト) フィールドのグループは、レコードの独自の XPath述語属性で更新されました。 はい
path (change エレメント下にネスト) レコード内のパス。 はい
path (changes エレメント下にネスト) データセット内のパス。 はい
data (updated エレメント下にネスト) データセットまたは更新済みレコードの XML エクスポートに対応するこのエレメント下のコンテンツ。 いいえ
deleted レコードはリクエストのコンテキストから削除されました。 レコードの XPath 述語を含む predicate エレメントのリストに対応するコンテンツ。 いいえ
pagination リクエストでページ機能が有効の場合。 変更の永続化コンテキストを取得すると、最後のページまで、またはコンテキストタイムアウトに達するまで、次のページを呼び出すことができます。 次のページが含まれます：identifier を使用して context エレメントを定義します。 最後のページ：identifier を使用せずに context エレメントを定義します。 ページネーションを有効にします。以下の子エレメントを参照してください。 いいえ
context (pagination エレメント下にネスト) ページ付けコンテキストのコンテンツを定義します。 はい (next および last のみ)
identifier (context エレメント下にネスト) ページ付けコンテキスト識別子。最後に返されたページでは定義されていません。 いいえ
pageNumber (context エレメント下にネスト) ページ付けコンテキストの現在のページ番号。 はい
totalPages (context エレメント下にネスト) ページ付けコンテキストの合計ページ数。 はい

ページ機能を有効にした getChanges 操作

pagination エレメントとサブエレメントのみが説明されています。
作成用
リクエストの抜粋
...
    <pagination>
        <!-- on first request for creation -->
        <pageSize>Integer</pageSize>
    </pagination>
...
応答の抜粋
...
    <pagination>
        <!-- on next request to continue -->
        <context>
            <identifier>String</identifier>
            <pageNumber>Integer</pageNumber>
            <totalPages>Integer</totalPages>
        </context>
    </pagination>
...
次のステップ
リクエストの抜粋
...
    <pagination>
        <context>
            <identifier>String</identifier>
        </context>
    </pagination>
...
応答の抜粋
...
    <pagination>
        <!-- on next request to continue -->
        <context>
            <identifier>String</identifier>
            <pageNumber>Integer</pageNumber>
            <totalPages>Integer</totalPages>
        </context>
    </pagination>
...
最後のステップ
リクエストの抜粋
...
    <pagination>
        <context>
            <identifier>String</identifier>
        </context>
    </pagination>
...
応答の抜粋
...
    <pagination>
        <context>
            <pageNumber>Integer</pageNumber>
            <totalPages>Integer</totalPages>
        </context>
    </pagination>
...

getCredentials 操作

getCredentials リクエスト

<m:getCredentials_{TableName} xmlns:m="urn:ebx-schemas:dataservices_1.0">
    <branch>String</branch>
    <version>String</version>
    <instance>String</instance>
    <predicate>String</predicate>
    <viewPublication>String</viewPublication>
    <disableRedirectionToLastBroadcast>boolean</disableRedirectionToLastBroadcast>
</m:getCredentials_{TableName}>
と：
エレメント 説明 必須
branch 共通パラメーターの説明を参照してください。
version 共通パラメーターの説明を参照してください。
instance 共通パラメーターの説明を参照してください。
predicate 共通パラメーターの説明を参照してください。
viewPublication 共通パラメーターの説明を参照してください。

getCredentials 応答

<ns1:getCredentials_{TableName}Response xmlns:ns1="urn:ebx-schemas:dataservices_1.0">
    <XX>
        <TableName>
            <a>R</a>
            <b>W</b>
            <c>H</c>
            <d>W</d>
            ...
        </TableName>
    </XX>
</ns1:getCredentials_{TableName}Response>
次の可能な値を使用します。
  • R：読み取り専用
  • W：読み取り/書き込み用
  • H：隠し用

複数連鎖操作

複数操作のリクエスト

一貫した応答を確保しながら、データセット内のテーブル間で複数の操作を実行することが可能です。操作は、クライアント側で定義された順序に従って順番に実行されます。
すべての操作は、SERIALIZABLE 分離レベルの単一トランザクションで実行されます。複数操作のすべての要求が読み取り専用である場合、同じデータスペース内であっても、他の読み取り専用トランザクションと同時に完全に実行できます。
シーケンスの 1 つの操作中にエラーが発生すると、すべての更新がロールバックされ、クライアントは詳細を含む StandardException エラーメッセージを受け取ります。
同時実行を参照してください。
<m:multi_ xmlns:m="urn:ebx-schemas:dataservices_1.0">
    <branch>String</branch>
    <version>String</version>
    <instance>String</instance>
    <blockingConstraintsDisabled>boolean</blockingConstraintsDisabled>
    <disableRedirectionToLastBroadcast>boolean</disableRedirectionToLastBroadcast>
    <details locale="Locale"/>
    <request id="id1">
        <{operation}_{TableName}>
        ...
        </{operation}_{TableName}>
    </request>
    <request id="id2">
        <{operation}_{TableName}>
        ...
        </{operation}_{TableName}>
    </request>
</m:multi_>
と：
エレメント 説明 必須
branch 共通パラメーターの説明を参照してください。
version 共通パラメーターの説明を参照してください。
instance 共通パラメーターの説明を参照してください。
blockingConstraintsDisabled 共通パラメーターの説明を参照してください。
詳細 共通パラメーターの説明を参照してください。
disableRedirectionToLastBroadcast 共通パラメーターの説明を参照してください。
request このエレメントには、ブランチ、バージョン、インスタンスのパラメーターを含まない単一の操作のように、1 つの操作が含まれます。このエレメントは、追加の操作のために複数回繰り返すことができます。各リクエストは、「id」属性で識別できます。応答では、この「id」属性が識別目的で返されます。 count、select、getChanges、getCredentials、insert、delete、update などの操作。 はい
注意：
  • request エレメントの数の制限を受け入れません。
  • リクエストの id 属性は、複数操作のリクエストで一意である必要があります。
  • すべての操作が読み取り専用の場合 (count、select、getChanges、または getCredentials)、パフォーマンスを考慮して、トランザクション全体が読み取り専用に設定されます。
    制限事項
  • 複数操作は、1 つのモデルと 1 つのデータセット (パラメーター instance) に適用されます。
以下も参照してください。:

複数操作の応答

詳細については、各応答操作を参照してください。
<ns1:multi_Response xmlns:ns1="urn:ebx-schemas:dataservices_1.0">
    <response id="id1">
        <{operation}_{TableName}Response>
        ...
        </{operation}_{TableName}Response>
    </response>
    <response id="id2">
        <{operation}_{TableName}Response>
        ...
        </{operation}_{TableName}Response>
    </response>
</ns1:multi_Response>
と：
エレメント 説明
response このエレメントには、1 つの操作の応答が含まれます。追加の操作のために複数回繰り返されます。各応答は、要求で設定された、または自動的に生成された「id」属性によって識別されます。 エレメントの内容は、count、select、getChanges、getCredentials、insert、delete、update などの単一の操作の応答に対応するものです。

楽観ロック

以前に読み取られたが、その間に変更された可能性のあるレコードの Update または Delete 操作を防ぐために、楽観ロックメカニズムが提供されています。
エレメント includesMetadata を system 値とともに追加することにより、Select リクエストに技術情報を含めることができます。
<m:select_{TableName} xmlns:m="urn:ebx-schemas:dataservices_1.0">
    <branch>String</branch>
    <version>String</version>
    <instance>String</instance>
    <predicate>String</predicate>
    <includesMetadata>system</includesMetadata>
</m:select_{TableName}>
次の更新リクエストでは、ebx-metadata/system/update_time エレメントの値を使用します。指定した時刻以降にレコードが変更された場合、更新はキャンセルされます。変更されたレコードが更新されないようにするには、ebx-metadata/system/update_time エレメントの値を追加します。
<m:update_{TableName} xmlns:m="urn:ebx-schemas:dataservices_1.0">
    <branch>String</branch>
       <version>String</version>
    <instance>String</instance>
    <updateOrInsert>true</updateOrInsert>
    <data>
        <XX>
            <TableName>
                <a>String</a>
                <b>String</b>
                <c>String</c>
                <d>String</d>
                ...
                <ebx-metadata>
                    <system>
                        ...
                        <update_time>2010-06-28T10:10:31.046</update_time>
                    </system>
                </ebx-metadata>
            </TableName>
        </XX>
    </data>
</m:update_{TableName}>
lastTime 属性の値を使用して、変更されたレコードの削除を防ぐこともできます。
<m:delete_{TableName} xmlns:m="urn:ebx-schemas:dataservices_1.0">
    <branch>String</branch>
    <version>String</version>
    <instance>String</instance>
    <predicate>String</predicate>
    <checkNotChangedSinceLastTime>2010-06-28T10:10:31.046</checkNotChangedSinceLastTime>
</m:delete_{TableName}>
注意:
checkNotChangedSinceLastTime エレメントは複数回使用できますが、同じレコードに対してのみ使用できます。これは、predicate エレメントが複数のレコードを返す場合、リクエストが失敗することを意味します。

データセットとデータスペースの操作

データスペースとスナップショットの操作のパラメーターは次のとおりです。
エレメント 説明 必須
branch 操作が適用されるターゲットデータスペースの識別子。指定しない場合、必要なデータスペースのマージ操作を除いて、「参照」データスペースが使用されます。 このパラメーターまたは「version」パラメーターのいずれかを定義する必要があります。データスペースのマージ、ロック、ロック解除、およびレプリケーションの Update 操作に必要です。
version 操作が適用されるターゲットスナップショットの識別子。 このパラメーターまたは「branch」パラメーターのいずれかを定義する必要があります。
versionName 作成するスナップショットの識別子。空の場合、サーバー側で定義されます。 いいえ
childBranchName 作成するデータスペースの子の識別子。空の場合、サーバー側で定義されます。 いいえ
instance 操作が適用されるデータセットの一意の名前。 レプリケーションの更新操作に必要です。
ensureActivation このインスタンスがアクティブ化されているかどうかも検証で確認する必要があるかどうかを定義します。 はい
details 検証が詳細を返すかどうかを定義します。 オプションの属性 severityThreshold は、返すメッセージの最低の重大度レベルを定義します。可能な値は、重大度の降順で、「fatal」、「error」、「warning」、または「info」です。たとえば、値を「error」に設定すると、エラーおよび致命的な検証メッセージが返されます。この属性が定義されていない場合、デフォルトですべてのレベルのメッセージが返されます。 オプションの属性 locale (デフォルトは「en-US」) は、検証メッセージが返される言語を定義します。 いいえ。指定しない場合、詳細は返されません。
owner 所有者を定義します。 Profile.format によって返される内部フォーマットを使用する必要があります。 いいえ
branchToCopyPermissionFrom 権限のコピー元となるデータスペースの識別子を定義します。 いいえ
documentation 専用言語のドキュメント。 複数の documentation エレメントを複数の言語で使用できます。 いいえ
locale (documentation エレメント下にネスト) ドキュメントのロケール。 documentation エレメントが使用されている場合にのみ必要です。
label (documentation エレメント下にネスト) 言語のラベル。 番号
description (documentation エレメント下にネスト) 言語の説明。 番号

データスペースを検証する

データスペースリクエストを検証する

<m:validate xmlns:m="urn:ebx-schemas:dataservices_1.0">
    <branch>String</branch>
    <version>String</version>
</m:validate>

データスペースの応答を検証する

<ns1:validate_Response xmlns:ns1="urn:ebx-schemas:dataservices_1.0">
    <validationReport>
        <instanceName>String</instanceName>
        <fatals>boolean</fatals>
        <errors>boolean</errors>
        <infos>boolean</infos>
        <warnings>boolean</warnings>
    </validationReport>
</ns1:validate_Response>

データセットの検証

データセットリクエストを検証する

<m:validateInstance xmlns:m="urn:ebx-schemas:dataservices_1.0">
    <branch>String</branch>
    <version>String</version>
    <instance>String</instance>
    <ensureActivation>boolean</ensureActivation>
    <details severityThreshold="fatal|error|warning|info" locale="Locale"/>
</m:validateInstance>

データセットの応答を検証する

<ns1:validateInstance_Response xmlns:ns1="urn:ebx-schemas:dataservices_1.0">
    <validationReport>
        <instanceName>String</instanceName>
        <fatals>boolean</fatals>
        <errors>boolean</errors>
        <infos>boolean</infos>
        <warnings>boolean</warnings>
        <details>
            <reportItem>
                <severity>{fatal|error|warning|info}</severity>
                <message>
                    <internalId />
                    <text>String</text>
                </message>
                <subject>
                    <table>Path</table>
                    <predicate>String</predicate>
                    <path>Path</path>
                </subject>
            </reportItem>
        </details>
    </validationReport>
</ns1:validateInstance_Response>

データスペースの作成

データスペースリクエストの作成

<m:createBranch xmlns:m="urn:ebx-schemas:dataservices_1.0">
    <branch>String</branch>
    <owner>String</owner>
    <branchToCopyPermissionFrom>String</branchToCopyPermissionFrom>
    <documentation>
        <locale>Locale</locale>
        <label>String</label>
        <description>String</description>
    </documentation>
    <childBranchName>String</childBranchName>
</m:createBranch>

データスペース応答を作成する

<ns1:createBranch_Response xmlns:ns1="urn:ebx-schemas:dataservices_1.0">
    <status>String</status>
    <childBranchName>String</childBranchName>
</ns1:createBranch_Response>
と：
要素 説明
status 「00」は、操作が正常に実行されたことを示します。

スナップショットの作成

スナップショットリクエストの作成

<m:createVersion xmlns:m="urn:ebx-schemas:dataservices_1.0">
    <branch>String</branch>
    <versionName>String</versionName>
    <owner>String</owner>
    <documentation>
        <locale>Locale</locale>
        <label>String</label>
        <description>String</description>
    </documentation>
</m:createVersion>

スナップショット応答を作成する

<ns1:createVersion_Response xmlns:ns1="urn:ebx-schemas:dataservices_1.0">
    <status>String</status>
    <versionName>String</versionName>
</ns1:createVersion_Response>
と：
要素 説明
status 「00」は、操作が正常に実行されたことを示します。

データスペースのロック

データスペースリクエストをロックする

<m:lockBranch xmlns:m="urn:ebx-schemas:dataservices_1.0">
    <branch>String</branch>
    <durationToWaitForLock>Integer</durationToWaitForLock>
    <message>
        <locale>Locale</locale>
        <label>String</label>
    </message>
</m:lockBranch>
と：
要素 説明 必須
durationToWaitForLock このパラメーターは、操作が中止する前にロックを待機する最大期間（秒単位）を定義します。 いいえ、デフォルトでは待機しません
message ロックのユーザーメッセージ。複数の message要素を使用できます。 番号
locale（message要素の下にネストされています） ユーザーメッセージのロケール。 message要素が使用されている場合にのみ必要です
label（message要素の下にネストされています） ユーザーメッセージ。 番号

データスペースの応答をロックする

<ns1:lockBranch_Response xmlns:ns1="urn:ebx-schemas:dataservices_1.0">
    <status>String</status>
</ns1:lockBranch_Response>
と：
要素 説明
status 「00」は、操作が正常に実行されたことを示します。 「94」は、データスペースが別のユーザーによってすでにロックされていることを示します。 それ以外の場合は、SOAP例外がスローされます。

データスペースのロックを解除する

データスペースリクエストのロックを解除する

<m:unlockBranch xmlns:m="urn:ebx-schemas:dataservices_1.0">
    <branch>String</branch>
</m:unlockBranch>

データスペース応答のロックを解除する

<ns1:unlockBranch_Response xmlns:ns1="urn:ebx-schemas:dataservices_1.0">
    <status>String</status>
</ns1:unlockBranch_Response>
と：
要素 説明
status 「00」は、操作が正常に実行されたことを示します。 それ以外の場合は、SOAP例外がスローされます。

データスペースのマージ

データスペースリクエストのマージ

<m:mergeBranch xmlns:m="urn:ebx-schemas:dataservices_1.0">
    <branch>String</branch>
    <deleteDataOnMerge>boolean</deleteDataOnMerge>
    <deleteHistoryOnMerge>boolean</deleteHistoryOnMerge>
</m:mergeBranch>
と：
要素 説明 必須
deleteDataOnMerge このパラメーターは、データスペースのマージ操作に使用できます。指定したデータスペースとそれに関連するスナップショットをマージ時に削除するかどうかを設定します。 このパラメータがリクエストで指定されていない場合、デフォルト値は falseになります。EBX® メイン構成ファイル でプロパティ ebx.dataservices.dataDeletionOnCloseOrMerge.defaultを指定することで、デフォルト値を再定義できます。 詳細については、データと履歴の削除を参照してください。 番号
deleteHistoryOnMerge このパラメーターは、データスペースのマージ操作に使用できます。指定したデータスペースに関連付けられている履歴をマージ時に削除するかどうかを設定します。デフォルト値は falseです。 このパラメータがリクエストで指定されていない場合、デフォルト値は falseになります。EBX® メイン構成ファイル でプロパティ ebx.dataservices.historyDeletionOnCloseOrMerge.defaultを指定することで、デフォルト値を再定義できます。 詳細については、データと履歴の削除を参照してください。 番号
注:
マージ決定ステップは、データサービスを介して実行されるマージ中にバイパスされます。このような場合、子データスペースのデータは親データスペースのデータを自動的に上書きします。

データスペースの応答をマージする

<ns1:mergeBranch_Response xmlns:ns1="urn:ebx-schemas:dataservices_1.0">
    <status>String</status>
</ns1:mergeBranch_Response>
と：
要素 説明
status 「00」は、操作が正常に実行されたことを示します。

データスペースまたはスナップショットを閉じる

データスペースまたはスナップショットリクエストを閉じる

データスペースリクエストを閉じる：
<m:closeBranch xmlns:m="urn:ebx-schemas:dataservices_1.0">
    <branch>String</branch>
    <deleteDataOnClose>boolean</deleteDataOnClose>
    <deleteHistoryOnClose>boolean</deleteHistoryOnClose>
</m:closeBranch>
スナップショットリクエストを閉じる：
<m:closeVersion xmlns:m="urn:ebx-schemas:dataservices_1.0">
    <version>String</version>
    <deleteDataOnClose>boolean</deleteDataOnClose>
</m:closeVersion>
と：
要素 説明 必須
deleteDataOnClose このパラメーターは、データスペースのクローズおよびスナップショットのクローズ操作に使用できます。指定されたスナップショット、またはデータスペースとそれに関連するスナップショットを閉じるときに削除するかどうかを設定します。 このパラメータがリクエストで指定されていない場合、デフォルト値は falseです。EBX® メイン構成ファイル でプロパティ ebx.dataservices.dataDeletionOnCloseOrMerge.defaultを指定することで、このデフォルト値を再定義できます。 詳細については、データと履歴の削除を参照してください。 番号
deleteHistoryOnClose このパラメーターは、データスペースを閉じる操作に使用できます。指定したデータスペースに関連付けられている履歴を閉じるときに削除するかどうかを設定します。デフォルト値は falseです。 このパラメータがリクエストで指定されていない場合、デフォルト値は falseになります。EBX® メイン構成ファイル でプロパティ ebx.dataservices.historyDeletionOnCloseOrMerge.defaultを指定することで、デフォルト値を再定義できます。 番号

データスペースまたはスナップショット応答を閉じる

データスペースの応答を閉じる：
<ns1:closeBranch_Response xmlns:ns1="urn:ebx-schemas:dataservices_1.0">
    <status>String</status>
</ns1:closeBranch_Response>
スナップショット応答を閉じる：
<ns1:closeVersion_Response xmlns:ns1="urn:ebx-schemas:dataservices_1.0">
    <status>String</status>
</ns1:closeVersion_Response>

レプリケーションの更新

レプリケーション更新リクエスト

<m:replicationRefresh_${schema} xmlns:m="urn:ebx-schemas:dataservices_1.0">
    <branch>String</branch>
    <instance>String</instance>
    <unitName>String</unitName>
</m:replicationRefresh_${schema}>
と：
要素
説明
必須
ブランチ
共通パラメータの説明を参照してください。
はい
実例
共通パラメータの説明を参照してください。
はい
ユニット名
レプリケーション ユニットの名前。
も参照してください:
はい

レプリケーション更新応答

<ns1:replicationRefresh_${schema}Response xmlns:ns1="urn:ebx-schemas:dataservices_1.0">
    <status>String</status>
</ns1:replicationRefresh_${schema}Response>
と：
要素 説明
status 「00」は、操作が正常に実行されたことを示します。

データワークフローの操作

データワークフロー操作のパラメーターは、セッションのSOAPヘッダーから取得されます。
バージョン5.7.0以降は非推奨で、SOAPメッセージ本文にパラメータを定義します。
詳細については、セッションパラメータを参照してください。
要素
説明
必須
パラメーター
バージョン5.7.0以降非推奨下位互換性のために引き続き使用できますが、将来のメジャーバージョンで最終的に削除される予定です。
注:
少なくとも1つのセッションパラメータが定義されている場合、parameters要素は無視されます。
番号
パラメータ（パラメータ要素の下にネストされています）。複数のパラメータ要素を使用できます。
ワークフローの入力パラメーター。
番号
名前（パラメータ要素の下にネストされています）
パラメータの名前
はい
値（パラメータ要素の下にネストされています）
パラメータの値。
番号

ワークフローを開始する

ワークフローランチャーからワークフローを開始します。ローカライズされたドキュメントと特定の入力パラメーター（名前とオプションの値）を使用してワークフローを開始することができます。
注:
ワークフロー作成者はセッションから初期化され、ワークフローの優先度は最後に公開されたバージョンから取得されます。
サンプルリクエスト：
<m:workflowProcessInstanceStart xmlns:m="urn:ebx-schemas:dataservices_1.0">
    <publishedProcessKey>String</publishedProcessKey>
    <documentation>
        <locale>Locale</locale>
        <label>String</label>
        <description>String</description>
    </documentation>
</m:workflowProcessInstanceStart>
と：
要素 説明 必須
公開されたプロセスキー ワークフローランチャーの識別子。 はい
ドキュメンテーション 共通パラメータの説明を参照してください。 番号
パラメーター バージョン5.7.0以降非推奨 共通パラメータの説明を参照してください。 番号
サンプルの回答：
<m:workflowProcessInstanceStart_Response xmlns:m="urn:ebx-schemas:dataservices_1.0">
    <processInstanceKey>String</processInstanceKey>
</m:workflowProcessInstanceStart_Response>
と：
要素 説明 必須
processInstanceId バージョン5.6.1以降非推奨このパラメーターは「processInstanceKey」パラメーターに置き換えられました。下位互換性のために引き続き使用できますが、将来のメジャーバージョンで最終的に削除される予定です。 番号
processInstanceKey ワークフロー識別子。 番号

ワークフローを再開します

再開IDから待機ステップでワークフローを再開します。特定の入力パラメーター（名前とオプションの値）を定義することができます。
サンプルリクエスト：
<m:workflowProcessInstanceResume xmlns:m="urn:ebx-schemas:dataservices_1.0">
    <resumeId>String</resumeId>
</m:workflowProcessInstanceResume>
と：
要素 説明 必須
resumeId 待機中のタスクのIDを再開します。 はい
パラメーター バージョン5.7.0以降非推奨 共通パラメータの説明を参照してください。 番号
サンプルの回答：
<m:workflowProcessInstanceResume_Response xmlns:m="urn:ebx-schemas:dataservices_1.0">
    <status>String</status>
    <processInstanceKey>String</processInstanceKey>
</m:workflowProcessInstanceResume_Response>
と：
要素 説明 必須
status 「00」は、操作が正常に実行されたことを示します。 「20」は、ワークフローが見つからなかったことを示します。 「21」は、イベントがすでに受信されていることを示します。 はい
processInstanceKey ワークフローの識別子。このパラメーターは、操作が正常に実行された場合に返されます。 番号

ワークフローを終了する

識別子からワークフローを終了します。
サンプルリクエスト：
<m:workflowProcessInstanceEnd xmlns:m="urn:ebx-schemas:dataservices_1.0">
    <processInstanceKey>String</processInstanceKey>
</m:workflowProcessInstanceEnd>
と：
要素 説明 必須
processInstanceKey ワークフローの識別子。 このパラメーターまたは「publishedProcessKey」および「processInstanceId」パラメーターのいずれかを定義する必要があります。
公開されたプロセスキー バージョン5.6.1以降非推奨制限により、このパラメーターは「processInstanceKey」パラメーターに置き換えられました。下位互換性のために引き続き使用できますが、将来のメジャーバージョンで最終的に削除される予定です。 番号
processInstanceId バージョン5.6.1以降非推奨制限により、このパラメーターは「processInstanceKey」パラメーターに置き換えられました。下位互換性のために引き続き使用できますが、将来のメジャーバージョンで最終的に削除される予定です。 番号
サンプルの回答：
<m:workflowProcessInstanceEnd_Response xmlns:m="urn:ebx-schemas:dataservices_1.0">
    <status>String</status>
</m:workflowProcessInstanceEnd_Response>
と：
要素 説明 必須
status 「00」は、操作が正常に実行されたことを示します。 はい

行政サービス

ディレクトリサービス

ディレクトリのサービスは、デフォルト ディレクトリの「ユーザー」および「ロール」テーブルに対する操作を提供します。これらのサービスに関連する操作を実行するには、認証されたユーザーが組み込みロール「管理者」のメンバーである必要があります。
技術データスペースとデータセットは ebx-directoryに設定する必要があります。すべての SOAP 操作構文の詳細については、データ モデルから生成された操作 を参照してください。

ディレクトリにユーザーを作成する

この SOAP 挿入要求の例では、EBX® ディレクトリにユーザーを追加します。
<m:insert_user xmlns:m="urn:ebx-schemas:dataservices_1.0">
    <branch>ebx-directory</branch>
    <instance>ebx-directory</instance>
    <data>
    <directory>
        <users>
            <login>login</login>
            <lastName>lastname</lastName>
            <firstName>firstname</firstName>
            <email>firstname.lastname@email.com</email>
            <password>***</password>
            <passwordMustChange>true</passwordMustChange>
            <builtInRoles>
                <administrator>false</administrator>
                <readOnly>false</readOnly>
            </builtInRoles>
            <comments>a comment</comments>
        </users>
    </directory>
    </data>
</m:insert_user>
挿入 SOAP 応答構文の詳細については、挿入応答 を参照してください。

ユーザーインターフェース操作

詳細については、アプリケーションのロックを参照してください。
ユーザー インターフェースでの操作のパラメーターは次のとおりです。
要素 説明 必須
closedMessage ユーザー インターフェースが閉じられてアクセスできないときにユーザーに表示されるメッセージ。 番号

ユーザーインターフェース要求を閉じる

閉じる操作により、このモードで受け入れられないすべてのユーザー セッションが削除されます。
<m:close xmlns:m="urn:ebx-schemas:dataservices_1.0">
    <closedMessage>Access is temporarily forbidden.</closedMessage>
</m:close>

ユーザーインターフェースの応答を閉じる

<ns1:close_Response xmlns:ns1="urn:ebx-schemas:dataservices_1.0">
    <status>String</status>
</ns1:close_Response>

オープンユーザーインターフェースリクエスト

<m:open xmlns:m="urn:ebx-schemas:dataservices_1.0"/>

オープンユーザーインターフェースの応答

<ns1:open_Response xmlns:ns1="urn:ebx-schemas:dataservices_1.0">
    <status>String</status>
</ns1:open_Response>

システム情報操作

この操作は、EBX® システム情報を返します。返される情報は、ログ ヘッダー kernel.log または UI タブ > に含まれる情報と同じです。応答には、EBX®の構成とステータスを表すいくつかのキー、ラベル、値が含まれます。この操作を実行するには、認証されたユーザーが組み込みロール「管理者」のメンバーである必要があります。

パラメーター

以下のパラメータが適用されます。
パラメータ 説明 必須
details 応答メッセージに適用する必要がある属性を定義します。 属性 locale (デフォルト: EBX® デフォルト locale) は、システム項目メッセージが返される言語を定義します。 いいえ。ただし、指定する場合は、locale 属性を指定する必要があります。

システム情報要求

この SOAP リクエストは、EBX® インスタンスのすべてのシステム情報を返し、"en_US" ロケールを使用してフォーマットします。
<m:systemInformation xmlns:m="urn:ebx-schemas:dataservices_1.0">
    <details locale="en_US" />
</m:systemInformation>

システム情報応答

<ns1:systemInformation_Response xmlns:ns1="urn:ebx-schemas:dataservices_1.0">
    <bootInfoEBX>
        <label>String</label>
        <infoItem>
            <key>String</key>
            <label>String</label>
            <content>String</content>
            <content>String</content>
            ...
        </infoItem>
        ...
    </bootInfoEBX>
    <repositoryInfo>
        <label>String</label>
        <infoItem>
            <key>String</key>
            <label>String</label>
            <content>String</content>
            <content>String</content>
            ...
        </infoItem>
        ...
    </repositoryInfo>
    <bootInfoVM>
        <label>String</label>
        <infoItem>
            <key>String</key>
            <label>String</label>
            <content>String</content>
            ...
        </infoItem>
        ...
    </bootInfoVM>
</ns1:systemInformation_Response>