SOAP 操作
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 検証がアクティブ化されると、エラーが返されます。
この「デフォルトビュー」の設定は、データモデル内で定義されています。
以下も参照してください。:
関連付けフィールド
テーブルレコードの読み取りアクセスは、UI マネージャーに表示されるように関連フィールドをエクスポートできます。この機能は、「hiddenInDataServices」モデルパラメーターと組み合わせることができます。
注意:
制限事項：変更および Update 操作では、関連付けフィールドは管理されません。また、Select 操作では、最初のレベルの関連付けエレメントのみがエクスポートされます (関連付けられたオブジェクトのコンテンツに関連付けエレメントを含めることはできません)。
共通のリクエストパラメーター
パラメーターの一部は複数の操作に共通です。詳細は以下のとおりです。
|
エレメント
|
説明
|
必須
|
|---|---|---|
|
branch
|
データセットが属するデータスペースの識別子。
|
このパラメーターまたは「version」パラメーターのいずれかを定義する必要があります。「Insert」、「Update」、および「Delete」操作に必要です。
|
|
version
|
データセットが属するスナップショットの識別子。
|
このパラメーターまたは「branch」パラメーターのいずれかを定義する必要があります。
|
|
instance
|
クエリするテーブルを含むデータセットの一意の名前。
|
はい
|
|
predicate
|
XPath 述語は、リクエストが適用されるレコードを定義します。空の場合、このフィールドが必須である「Delete」操作を除いて、すべてのレコードが取得されます。
以下も参照してください。:
|
「Delete」操作にのみ必要です。
|
|
data
|
データモデルの構造内で表される、変更されるレコードが含まれます。操作全体は、XML インポートと同等です。データコンテンツに対して実行される操作の詳細については、インポートセクションで指定されます。
|
Insert および Update 操作にのみ必要です。
|
|
viewPublication
|
このパラメーターは、論理演算子 AND として
predicate パラメーターと組み合わせることができます。
このパラメーターの動作については、Web コンポーネントとしての EBX® セクションに説明が記載されています。
「viewId」パラメーターが使用されている場合は使用できず、階層ビューまたはタイルビューでは使用できません。
|
いいえ
|
|
viewId
|
バージョン 5.2.3 以降非推奨。このパラメーターは、パラメーター「viewPublication」に置き換えられました。下位互換性のために引き続き使用できますが、将来のバージョンで最終的に削除される予定です。
「viewPublication」パラメーターが使用されている場合、このパラメーターは使用できません。
|
いいえ
|
|
blockingConstraintsDisabled
|
このプロパティは、すべてのテーブル更新データサービス操作で使用できます。
true の場合、検証プロセスはデータモデルで定義されたブロッキング制約を無効にします。
このパラメーターが存在しない場合、デフォルトは
false です。
詳細については、ブロッキングと非ブロッキングの制約を参照してください。
|
いいえ
|
|
details
|
details エレメントは、次のオプションを指定します。
オプションの属性 locale (デフォルトは「en-US」) は、検証メッセージを返す必要がある blockingConstraintsDisabled パラメーターの言語を定義します。
|
いいえ
|
|
disableRedirectionToLastBroadcast
|
このプロパティは、すべてのデータサービス操作で使用できます。
true の場合、D3 プライマリノード上の配信データスペースへのアクセスは、最後のブロードキャストスナップショットにリダイレクトされません。それ以外の場合、そのようなデータスペースへのアクセスは常に最後のスナップショットブロードキャストにリダイレクトされます。
このパラメーターが存在しない場合、構成プロパティ
ebx.dataservices.disableRedirectionToLastBroadcast.default が設定されていない限り、デフォルトは false (D3 マスターでのリダイレクトが有効) です。
指定されたデータスペースが D3 プライマリノードの配信データスペースでない場合、このパラメーターは無視されます。
|
いいえ
|
Select 操作
テーブルでの 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>String</includesMetadata>
<viewPublication>String</viewPublication>
<exportCredentials>boolean</exportCredentials>
<pagination>
<previousPageLastRecordPredicate>String</previousPageLastRecordPredicate>
<pageSize>Integer</pageSize>
</pagination>
<disableRedirectionToLastBroadcast>boolean</disableRedirectionToLastBroadcast>
</m:select_{TableName}>
追加事項：
|
エレメント
|
説明
|
必須
|
|---|---|---|
|
branch
|
共通パラメーターの説明を参照してください。
|
|
|
version
|
共通パラメーターの説明を参照してください。
|
|
|
instance
|
共通パラメーターの説明を参照してください。
|
|
|
predicate
|
共通パラメーターの説明を参照してください。
このパラメーターは、論理的な AND 操作として viewPublication パラメーターと組み合わせることができます。
|
|
|
viewPublication
|
共通パラメーターの説明を参照してください。
|
|
|
includesMetadata
|
応答には、指定されたメタデータが含まれています。返された各レコードには、
ebx-metadata ルートエレメントの下にステップと呼ばれる追加エレメントが含まれています。
たとえば、「system」ステップ値には技術データが含まれます。楽観ロックセクションも参照してください。
<system>
文字列値のステップ (デフォルト値は空) はカンマで区切る必要があります ( system, teamUp)。 ebx-all 値を使用して、すべてのステップを返すことができます。
|
いいえ
|
|
includesTechnicalData
|
バージョン 6.1.0 以降非推奨。
includesMetadata リクエストパラメーターに置き換えられました。 true の場合、レスポンスには技術データが含まれます。楽観ロックセクションも参照してください。
返される各レコードには、この技術情報の追加の属性が含まれます。以下はその例です。
...<table |
いいえ
|
|
exportCredentials
|
true の場合、SELECT で各レコードの資格情報も返されます。
|
いいえ
|
|
pagination
|
ページネーション構成を指定します。以下の子エレメントを参照してください。
|
いいえ
|
|
pageSize ( pagination エレメント下にネスト)
|
1 ページあたりのレコードの最大数を指定します。
整数型。デフォルト値は 10 です。
以下も参照してください。:
値 0 は、推奨される最大ページサイズを選択します。デフォルトは 10000 です。
以下も参照してください。:
注意:
指定またはデフォルトのページサイズ値が推奨される最大ページサイズを超える場合は、最大ページサイズが使用されます。
|
いいえ
|
|
previousPageLastRecordPredicate ( paginationエレメントの下にネスト)
|
ページネーションが有効になっている場合、ページをフェッチする必要があるレコードを定義する XPath 述語。この値は、エレメント lastRecordPredicate として前の応答によって提供されます。渡されたレコードが見つからない場合は、最初のページが返されます。
|
いいえ
|
|
disableRedirectionToLastBroadcast
|
共通パラメーターの説明を参照してください。
|
テーブルでの Select 応答
<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>
追加事項：
| エレメント | 説明 |
|---|---|
| data | テーブルパスの後に表示されるレコードのコンテンツ。 |
| credentials | 各レコードの各ノードのアクセス権限が含まれています。 |
| lastRecordPredicate | ページ機能が有効な場合にのみ返されます。これは、エレメント previousPageLastRecordPredicated で、次のリクエストで使用されるよう最後のレコードを定義します。 |
楽観ロックのセクションも参照してください。
データセットでの Select リクエスト
この操作は、テーブルなしでデータセットコンテンツを返します。
<m:selectInstance xmlns:m="urn:ebx-schemas:dataservices_1.0">
<branch>String</branch>
<version>String</version>
<instance>String</instance>
</m:selectInstance>
追加事項：
データセットでの Select 応答
<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>
追加事項：
| エレメント | 説明 |
|---|---|
| data | テーブルなしのデータセットコンテンツ。 |
Delete 操作
レコードを削除するか、子データセットの場合は、レコードのコンテキストに応じてレコードの状態を「非表示」または「継承」として定義します。レコードは、
predicate パラメーターで選択されます。
Delete リクエスト
<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}>
追加事項：
| エレメント | 説明 | 必須 |
|---|---|---|
| branch | 共通パラメーターの説明を参照してください。 | |
| instance | 共通パラメーターの説明を参照してください。 | |
| predicate | 共通パラメーターの説明を参照してください。 | |
| includeOcculting | 非表示モードのレコードが含まれます。 デフォルト値は false です。 |
いいえ |
| inheritIfInOccultingMode | 非表示モードの場合、親からレコードを継承します。 デフォルト値は false です。 |
いいえ |
| occultIfInherit | *バージョン 5.7.0 以降非推奨。*レコードが継承モードの場合、レコードを非表示にします。 デフォルト値は false です。 |
いいえ |
| checkNotChangedSinceLastTime | 最後の読み取り以降にレコードが変更されていないことを確認するために使用されるタイムスタンプ。楽観ロックセクションも参照してください。 | いいえ |
| blockingConstraintsDisabled | 共通パラメーターの説明を参照してください。 | |
| details | 共通パラメーターの説明を参照してください。 | |
| disableRedirectionToLastBroadcast | 共通パラメーターの説明を参照してください。 |
Delete 応答
指定されたパラメーターの 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」に等しい場合に存在します。メッセージのロケールは、リクエストパラメーターまたはユーザーセッションから取得されます。 |
Count 操作
Count リクエスト
<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}>
追加事項：
Count 応答
<ns1:count_{TableName}Response xmlns:ns1="urn:ebx-schemas:dataservices_1.0">
<count>Integer</count>
</ns1:count_{TableName}Response>
追加事項：
| エレメント | 説明 |
|---|---|
| count | リクエストの述語に対応するレコードの数。 |
Update 操作
Update リクエスト
<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}>
追加事項：
| エレメント | 説明 | 必須 |
|---|---|---|
| branch | 共通パラメーターの説明を参照してください。 | |
| instance | 共通パラメーターの説明を参照してください。 | |
| updateOrInsert | true でレコードが現在存在しない場合、操作によってレコードが作成されます。 ブール値型。デフォルト値は false です。 |
いいえ |
| byDelta | true に設定され、受信メッセージにエレメントが現在存在しない場合、ターゲット値は変更されません。 false に設定され、ノードが hiddenInDataServices に宣言されている場合、ターゲット値は変更されません。 完全な動作については、Insert および Update 操作セクションで説明しています。 |
いいえ |
| blockingConstraintsDisabled | 共通パラメーターの説明を参照してください。 | |
| details | 共通パラメーターの説明を参照してください。 | |
| disableRedirectionToLastBroadcast | 共通パラメーターの説明を参照してください。 | |
| data | 共通パラメーターの説明を参照してください。 |
以下も参照してください。:
Update 応答
<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」に等しい場合に存在します。メッセージのロケールは、リクエストパラメーターまたはユーザーセッションから取得されます。 |
Inset 操作
Insert リクエスト
<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}>
追加事項：
| エレメント | 説明 | 必須 |
|---|---|---|
| branch | 共通パラメーターの説明を参照してください。 | |
| instance | 共通パラメーターの説明を参照してください。 | |
| byDelta | true に設定され、受信メッセージにエレメントが現在存在しない場合、ターゲット値は変更されません。 false に設定され、ノードが hiddenInDataServices に宣言されている場合、ターゲット値は変更されません。 完全な動作については、Insert および Update 操作セクションで説明しています。 |
いいえ |
| blockingConstraintsDisabled | 共通パラメーターの説明を参照してください。 | |
| details | 共通パラメーターの説明を参照してください。 | |
| disableRedirectionToLastBroadcast | 共通パラメーターの説明を参照してください。 | |
| data | 共通パラメーターの説明を参照してください。 |
Insert 応答
<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」に等しい場合に存在します。メッセージのロケールは、リクエストパラメーターまたはユーザーセッションから取得されます。 |
| predicate | 挿入されたレコードの主キーに一致する述語。複数のレコードが挿入される場合、述語は入力メッセージ内のレコードの宣言順序に従います。 |
getChanges 操作
コンテンツポリシーに従って変更を返します。
getChanges リクエスト
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}>
追加事項：
| エレメント | 説明 | 必須 |
|---|---|---|
| branch | 共通パラメーターの説明を参照してください。 | |
| version | 共通パラメーターの説明を参照してください。 | |
| instance | 共通パラメーターの説明を参照してください。 | |
| compareWithBranch | 比較するデータスペースの識別子。 | このパラメーターまたは「compareWithVersion」パラメーターのいずれかを定義する必要があります。 |
| compareWithVersion | 比較するスナップショットの識別子。 | このパラメーターまたは compareWithBranch パラメーターのいずれかを定義する必要があります。 |
| compareWithInstance | 比較するデータセットの識別子。未定義の場合は、instance パラメーターが使用されます。 | いいえ |
| resolveMode | 差が解決モードで計算されるかどうかを定義します。デフォルトは true です。 詳細については、解決モードを参照してください。 |
いいえ |
| includeInstanceUpdates | データセットのコンテンツ更新を含めるかどうかを定義します。デフォルトは false です。 |
いいえ |
| pagination | getChanges 操作および getChangesOnDataSet 操作のページ付けコンテキストを有効にします。 クライアントがページ付けコンテキストサイズを定義できるようにします。各ページには、最大サイズに応じて、テーブルの挿入、更新、および/または削除されたレコードのコレクションが含まれています。 変更の取得の永続化コンテキストは、リクエストのページサイズパラメーターに従って、初回呼び出し時に構築されます。 ページネーションコンテキストはサーバーファイルシステムに保持され、最後のページまで、またはタイムアウトに達するまで次のページを呼び出すことができます。 作成の場合： pageSize パラメーターを定義します。 次のステップ：前の応答の識別子を使用してコンテキストエレメントを定義します。 ページネーションを有効にします。以下の子エレメントを参照してください。 |
いいえ |
pageSize ( pagination エレメント下にネスト) |
各ページのレコードの最大数を定義します。最小サイズは 50 です。 |
いいえ (作成のみ) |
context ( pagination エレメント下にネスト) |
ページ付けコンテキストのコンテンツを定義します。 | いいえ (next のみ) |
identifier ( context エレメント下にネスト) |
ページ付けコンテキスト識別子。 | はい |
| disableRedirectionToLastBroadcast | 共通パラメーターの説明を参照してください。 |
注意:
compareWithBranch または compareWithVersion パラメーターのいずれも指定されていない場合、比較はそれらの親で実行されます。
-
現在のデータスペースまたはスナップショットがデータスペースの場合、比較は最初のスナップショットで実行されます (データスペースで行われたすべての変更を含む)。
-
現在のデータスペースまたはスナップショットがスナップショットの場合、比較はその親データスペースで実行されます (現在のスナップショットの作成後に親データスペースで行われたすべての変更を含む)。
-
現在のデータスペースが「参照」データスペースの場合、例外を返します。
以下も参照してください。:
getChanges 応答
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>
追加事項：
| エレメント | 説明 | 必須 |
|---|---|---|
| inserted | 選択肢 compareWithBranch または compareWithVersion から挿入されたレコードが含まれます。 挿入されたレコードの XML エクスポートに対応するこのエレメントの下のコンテンツ。 |
いいえ |
| updated | 更新されたレコードまたはデータセットのコンテンツが含まれます。 | いいえ |
changes ( updated エレメント下にネスト) |
フィールドのグループのみが更新されています。 | はい |
change (変更エレメントの下にネスト) |
フィールドのグループは、レコードの独自の XPath 述語属性で更新されました。 |
はい |
path ( change エレメント下にネスト) |
レコード内のパス。 | はい |
path ( change エレメント下にネスト) |
データセット内のパス。 | はい |
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}>
追加事項：
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 | 共通パラメーターの説明を参照してください。 | |
| details | 共通パラメーターの説明を参照してください。 | |
| 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 | 操作が適用されるデータセットの一意の名前。 | レプリケーションの更新操作に必要です。 |
| sureActivation | このインスタンスがアクティブ化されているかどうかも検証で確認する必要があるかどうかを定義します。 | はい |
| 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 メッセージ本文でパラメーターを定義します。
詳細については、セッションパラメーターを参照してください。
|
エレメント
|
説明
|
必須
|
|---|---|---|
|
parameters
|
バージョン 5.7.0 以降非推奨。下位互換性のために引き続き使用できますが、将来のメジャーバージョンで最終的に削除される予定です。
注意:
少なくとも 1 つのセッションパラメーターが定義されている場合、
parameter エレメントは無視されます。
|
いいえ
|
|
parameter ( parameters エレメント下にネスト)。複数の parameter エレメントを使用できます。
|
ワークフローの入力パラメーター。
|
いいえ
|
|
name ( parameter エレメント下にネスト)
|
パラメーターの名前。
|
はい
|
|
value ( parameter エレメント下にネスト)
|
パラメーターの値。
|
いいえ
|
ワークフローの開始
ワークフローランチャーからワークフローを開始します。ローカライズされたドキュメントと特定の入力パラメーター (名前とオプションの値) を使用してワークフローを開始することができます。
注意:
ワークフローの作成者はセッションから初期化され、ワークフローの優先度は最後に公開されたバージョンから取得されます。
サンプルリクエスト
<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>
追加事項：
| エレメント | 説明 | 必須 |
|---|---|---|
| publishedProcessKey | ワークフローランチャーの識別子。 | はい |
| documentation | 共通パラメーターの説明を参照してください。 | いいえ |
| parameters | バージョン 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 | ワークフロー識別子。 | いいえ |
ワークフローの再開
再開識別子から待機ステップでワークフローを再開します。特定の入力パラメーター (名前とオプションの値を使用) を定義することができます。
サンプルリクエスト
<m:workflowProcessInstanceResume xmlns:m="urn:ebx-schemas:dataservices_1.0">
<resumeId>String</resumeId>
</m:workflowProcessInstanceResume>
追加事項：
| エレメント | 説明 | 必須 |
|---|---|---|
| resumeId | 待機中のタスクの ID を再開します。 | はい |
| parameters | バージョン 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」パラメーターのいずれかを定義する必要があります。 |
| publishedProcessKey | *バージョン 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」は、操作が正常に実行されたことを示します。 | はい |
管理サービス
ディレクトリサービス
ディレクトリ上のサービスは、デフォルトディレクトリの「Users」テーブルと「Roles」テーブルに対する操作を提供します。これらのサービスに関連する操作を実行するには、認証されたユーザーがビルトインのロール「管理者」のメンバーである必要があります。
技術データスペースとデータセットは
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 応答の挿入構文については、Insert 応答を参照してください。
ユーザーインターフェイスの操作
詳細については、アプリケーションのロックを参照してください。
ユーザーインターフェイスでの操作のパラメーターは次のとおりです。
| エレメント | 説明 | 必須 |
|---|---|---|
| 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>システム情報操作
パラメーター
以下のパラメーターが適用されます。
| パラメーター | 説明 | 必須 |
|---|---|---|
details |
応答メッセージに適用する必要のある属性を定義します。 属性 locale (デフォルト：EBX® default locale) は、システムアイテムメッセージを返す必要のある言語を定義します。 |
いいえ。ただし、指定する場合は、 locale 属性を指定する必要があります。 |
システム情報リクエスト
この SOAP リクエストは、すべての EBX® インスタンスのシステム情報を返し、「
en_US」 locale を使用してフォーマットを設定します。
<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>