SOAP 操作

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

TIBCO EBX® のリポジトリで使用されるデータモデルでは、その操作を定義する対応する WSDL を動的に生成することができます。この WSDL を使用すると、EBX® リポジトリの読み取りと書き込みが可能になります。たとえば、パス /root/XX/exampleTable 上のテーブルの場合、生成されるリクエストはその基になるデータモデルの構造に従い、テーブル名 <m:{operation}_exampleTable xmlns:m="urn:ebx-schemas:dataservices_1.0"> を含むことになります。

コンテンツポリシー

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

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

データモデルで定義されている hiddenInDataServices プロパティを使用すると、ユーザープロファイルに関係なく、データサービスのフィールドを常に非表示にできます。このパラメーターは、生成された WSDL に影響を与えます。非表示のフィールドまたはグループは、要求および応答の構造に含まれません。

hiddenInDataServices パラメーターの値を変更すると、以前の WSDL を引き続き使用するクライアントに次の影響があります。

• リクエストに応じて、データモデルプロパティが true に変更され、関連するフィールドが WSDL リクエストに存在する場合、例外がスローされます。

• 応答時に、スキーマプロパティが false に変更されている場合、WSDL 検証がアクティブ化されると、エラーが返されます。

この「デフォルトビュー」の設定は、データモデル内で定義されています。

関連付けフィールド

テーブルレコードの読み取りアクセスは、UI マネージャーに表示されるように関連フィールドをエクスポートできます。この機能は、「hiddenInDataServices」モデルパラメーターと組み合わせることができます。

共通のリクエストパラメーター

パラメーターの一部は複数の操作に共通です。詳細は以下のとおりです。

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}>

追加事項：

<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>

...<table
ebxd:lastTime="2010-06-28T10:10:31.046" ebxd:lastUser="Uadmin"
ebxd:uuid="9E7D0530-828C-11DF-B733-0012D01B6E76">... .

テーブルでの 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>

追加事項：

楽観ロックのセクションも参照してください。

データセットでの 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>

追加事項：

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}>

追加事項：

Delete 応答

指定されたパラメーターの 1 つが不正である場合、必要なパラメーターが欠落している場合、アクションが許可されていない場合、またはレコードが選択されていない場合は、例外が返されます。それ以外の場合は、特定の応答が返されます。

<ns1:delete_{TableName}Response xmlns:ns1="urn:ebx-schemas:dataservices_1.0">
	<status>String</status>
	<blockingConstraintMessage>String</blockingConstraintMessage>
</ns1:delete_{TableName}Response>

追加事項：

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>

追加事項：

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}>

追加事項：

Update 応答

<ns1:update_{TableName}Response xmlns:ns1="urn:ebx-schemas:dataservices_1.0">
	<status>String</status>
	<blockingConstraintMessage>String</blockingConstraintMessage>
</ns1:update_{TableName}Response>

追加事項：

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}>

追加事項：

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>

追加事項：

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}> 

追加事項：

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>

追加事項：

ページ機能を有効にした 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_>

追加事項：

注意：

• 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>

追加事項：

楽観ロック

以前に読み取られたが、その間に変更された可能性のあるレコードの 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}>

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

データスペースとスナップショットの操作のパラメーターは次のとおりです。

データスペースの検証

データスペース検証リクエスト

<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>

追加事項：

スナップショットの作成

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

<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>

追加事項：

データスペースのロック

データスペースロックリクエスト

<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>

追加事項：

データスペースロックの応答

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

追加事項：

データスペースロックの解除

データスペースロック解除リクエスト

<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>

追加事項：

データスペースのマージ

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

<m:mergeBranch xmlns:m="urn:ebx-schemas:dataservices_1.0"> 
	<branch>String</branch>
	<deleteDataOnMerge>boolean</deleteDataOnMerge>
	<deleteHistoryOnMerge>boolean</deleteHistoryOnMerge>
</m:mergeBranch>

追加事項：

データスペースマージの応答

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

追加事項：

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

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

データスペースを閉じるリクエスト

<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>

追加事項：

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

データスペースを閉じる応答

<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>

追加事項：

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

データワークフロー操作のパラメーターは、セッションの SOAP ヘッダーから取得されます。

バージョン 5.7.0 以降非推奨。SOAP メッセージ本文でパラメーターを定義します。

詳細については、セッションパラメーターを参照してください。

ワークフローの開始

ワークフローランチャーからワークフローを開始します。ローカライズされたドキュメントと特定の入力パラメーター (名前とオプションの値) を使用してワークフローを開始することができます。

サンプルリクエスト

<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>

追加事項：

サンプル応答

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

追加事項：

ワークフローの再開

再開識別子から待機ステップでワークフローを再開します。特定の入力パラメーター (名前とオプションの値を使用) を定義することができます。

サンプルリクエスト

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

追加事項：

サンプル応答

<m:workflowProcessInstanceResume_Response xmlns:m="urn:ebx-schemas:dataservices_1.0">
	<status>String</status>
	<processInstanceKey>String</processInstanceKey>
</m:workflowProcessInstanceResume_Response>

追加事項：

ワークフローの終了

識別子からワークフローを終了します。

サンプルリクエスト

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

追加事項：

サンプル応答

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

追加事項：

管理サービス

ディレクトリサービス

ディレクトリ上のサービスは、デフォルトディレクトリの「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 応答を参照してください。

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

詳細については、アプリケーションのロックを参照してください。

ユーザーインターフェイスでの操作のパラメーターは次のとおりです。

ユーザーインターフェイスを閉じるリクエスト

閉じる操作は、このモードで受け入れられないすべてのユーザーセッションを削除します。

<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® の構成とステータスを表すいくつかのキー、ラベル、および値が含まれています。この操作を実行するには、認証されたユーザーがビルトインのロール「管理者」のメンバーである必要があります。

パラメーター

以下のパラメーターが適用されます。

システム情報リクエスト

この 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>