SOAP operations

Operations generated from a data model

For a data model used in an EBX5 repository, it is possible to dynamically generate a corresponding WSDL, that defines its operations. When using this WSDL, it will be possible to read and/or write in the EBX5 repository. For example, for a table located at the path /root/XX/exampleTable, the generated requests would follow the structure of its underlying data model and include the name of the table <m:{operation}_exampleTable xmlns:m="urn:ebx-schemas:dataservices_1.0">.

Content policy

Access to the content of records, the presence or absence of XML elements, depend on the of the authenticated user session. Additional aspects, detailed below, can impact the content.

Disabling fields from data model

The hiddenInDataServices property, defined in the data model, allows always hiding fields in data services, regardless of the user profile. This parameter has an impact on the generated WSDL: any hidden field or group will be absent from the request and response structure.

Modifying the hiddenInDataServices parameter value has the following impact on a client which would still use the former WSDL:

• On request, if the data model property has been changed to true, and if the concerned field is present in the WSDL request, an exception will be thrown.

• On response, if the schema property has been changed to false, WSDL validation will return an error if it is activated.

This setting of "Default view" is defined inside data model.

Association field

Read-access on table records can export the association fields as displayed in UI Manager. This feature can be coupled with the 'hiddenInDataServices' model parameter.

Common request parameters

Several parameters are common to several operations and are detailed below.

Select operations

Select request on table

<m:select_{TableName} xmlns:m="urn:ebx-schemas:dataservices_1.0">
	<branch>String</branch>
	<version>String</version>
	<instance>String</instance>
	<predicate>String</predicate>
	<viewPublication>String</viewPublication>
	<exportCredentials>boolean</exportCredentials>
	<pagination>
		<previousPageLastRecordPredicate>String</previousPageLastRecordPredicate>
		<pageSize>Integer</pageSize>
	</pagination>
</m:select_{TableName}>

with:

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

Select response on table

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

with:

See also the optimistic locking section.

Select request on dataset

This operation returns dataset content without table.

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

with:

Select response on dataset

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

with:

Delete operation

Delete request

<m:delete_{TableName} xmlns:m="urn:ebx-schemas:dataservices_1.0">
	<branch>String</branch>
	<version>String</version>
	<instance>String</instance>
	<predicate>String</predicate>
	<includeOcculting>boolean</includeOcculting>
	<inheritIfInOccultingMode>boolean</inheritIfInOccultingMode>
	<checkNotChangedSinceLastTime>dateTime</checkNotChangedSinceLastTime>
	<blockingConstraintsDisabled>boolean</blockingConstraintsDisabled>
	<details locale="Locale"/>
</m:delete_{TableName}>

with:

Delete response

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

with:

Count operation

Count request

<m:count_{TableName} xmlns:m="urn:ebx-schemas:dataservices_1.0"> 
	<branch>String</branch> 
	<version>String</version> 
	<instance>String</instance> 
	<predicate>String</predicate>
</m:count_{TableName}>

with:

Count response

<ns1:count_{TableName}Response xmlns:ns1="urn:ebx-schemas:dataservices_1.0">
	<count>Integer</count>
</ns1:count_{TableName}Response>

with:

Update operation

Update request

<m:update_{TableName} xmlns:m="urn:ebx-schemas:dataservices_1.0">
	<branch>String</branch>
	<version>String</version>
	<instance>String</instance>
	<updateOrInsert>boolean</updateOrInsert>
	<byDelta>boolean</byDelta>
	<blockingConstraintsDisabled>boolean</blockingConstraintsDisabled>
	<details locale="Locale"/>
	<data>
		<XX>
			<TableName>
				<a>String</a>
				<b>String</b>
				<c>String</c>
				<d>String</d>
				...
			</TableName>
		</XX>
	</data>
</m:update_{TableName}>

with:

Update response

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

with:

Insert operation

Insert request

<m:insert_{TableName} xmlns:m="urn:ebx-schemas:dataservices_1.0">
	<branch>String</branch>
	<version>String</version>
	<instance>String</instance>
	<byDelta>boolean</byDelta>
	<blockingConstraintsDisabled>boolean</blockingConstraintsDisabled>
	<details locale="Locale"/>
	<data>
		<XX>
			<TableName>
				<a>String</a>
				<b>String</b>
				<c>String</c>
				<d>String</d>
				...
			</TableName>
		</XX>
	</data>
</m:insert_{TableName}>

with:

Insert response

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

with:

Get changes operations

Returns changes according to the Content policy.

Get changes requests

Changes between two datasets:

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

Changes between two tables:

<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>
</m:getChanges_{TableName}> 

with:

Get changes responses

Changes between two datasets:

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

Changes between two tables:

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

with:

Get changes operation with pagination enabled

Only pagination element and sub elements have been described.

For creation:

Extract of request:

...
	<pagination>
		<!-- on first request for creation -->
		<pageSize>Integer</pageSize>
	</pagination>
...

Extract of response:

...
	<pagination>
		<!-- on next request to continue -->
		<context>
			<identifier>String</identifier> 
			<pageNumber>Integer</pageNumber> 
			<totalPages>Integer</totalPages> 
		</context>
	</pagination>	
...

For next:

Extract of request:

...
	<pagination>
		<context>
			<identifier>String</identifier>
		</context> 
	</pagination>
...

Extract of response:

...
	<pagination>
		<!-- on next request to continue -->
		<context>
			<identifier>String</identifier> 
			<pageNumber>Integer</pageNumber> 
			<totalPages>Integer</totalPages> 
		</context>
	</pagination>	
...

For last:

Extract of request:

...
	<pagination>
		<context>
			<identifier>String</identifier>
		</context> 
	</pagination>
...

Extract of response:

...
	<pagination>
		<context>
			<pageNumber>Integer</pageNumber> 
			<totalPages>Integer</totalPages> 
		</context>
	</pagination>	
...

Get credentials operation

Get credentials request

<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>
</m:getCredentials_{TableName}>

with:

Get credentials response

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

With the following possible values:

• R: for read-only

• W: for read-write

• H: for hidden

Multiple chained operations

Multiple operations request

It is possible to run multiple operations across tables in the data set, while ensuring a consistent response. The operations are executed sequentially, according to the order defined on the client side.

All operations are executed in a single transaction with a SERIALIZABLE isolation level. If all requests in the multiple operation are read-only, they are allowed to run fully concurrently along with other read-only transactions, even in the same dataspace.

When an error occurs during one operation in the sequence, all updates are rolled back and the client receives a StandardException error message with details.

<m:multi_ xmlns:m="urn:ebx-schemas:dataservices_1.0">
	<branch>String</branch>
	<version>String</version>
	<instance>String</instance>
	<blockingConstraintsDisabled>boolean</blockingConstraintsDisabled>
	<details locale="Locale"/>
	<request id="id1">
		<{operation}_{TableName}>
		...
		</{operation}_{TableName}>
	</request>
	<request id="id2">
		<{operation}_{TableName}>
		...
		</{operation}_{TableName}>
	</request>
</m:multi_>

with:

Note:

• Does not accept a limit on the number of request elements.

• The request id attribute must be unique in multi-operation requests.

• If all operations are read only (count, select, getChanges, or getCredentials) then the whole transaction is set as read-only for performance considerations.

Limitation:

• The multi operation applies to one model and one data set (parameter instance).

• The select operation cannot use the pagination parameter.

Multiple operations response

See each response operation for details.

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

with:

Optimistic locking

To prevent an update or a delete operation on a record that was read earlier but may have changed in the meantime, an optimistic locking mechanism is provided.

A select request can include technical information by adding the element includesTechnicalData:

<m:select_{TableName} xmlns:m="urn:ebx-schemas:dataservices_1.0"> 
	<branch>String</branch> 
	<version>String</version> 
	<instance>String</instance> 
	<predicate>String</predicate> 
	<includesTechnicalData>boolean</includesTechnicalData> 
</m:select_{TableName}>

The value of the lastTime attribute can then be used in the following update request. If the record has been changed since the specified time, the update will be cancelled. The attribute lastTime has to be added on the record to prevent the update of a modified record.

<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 ebxd:lastTime="2010-06-28T10:10:31.046"> 
				<a>String</a> 
				<b>String</b> 
				<c>String</c> 
				<d>String</d> 
				... 
			</TableName> 
		</XX> 
	</data> 
</m:update_{TableName}>

The value of the lastTime attribute can also be used to prevent deletion on a modified record:

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

Operations on datasets and dataspaces

Parameters for operations on dataspaces and snapshots are as follows:

Validate a dataspace

Validate dataspace request

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

Validate dataspace response

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

Validate a dataset

Validate dataset request

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

Validate dataset response

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

Create a dataspace

Create dataspace request

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

Create dataspace response

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

with:

Create a snapshot

Create snapshot request

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

Create snapshot response

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

with:

Locking a dataspace

Lock dataspace request

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

with:

Lock dataspace response

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

with:

Unlocking a dataspace

Unlock dataspace request

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

Unlock dataspace response

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

with:

Merge a dataspace

Merge dataspace request

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

with:

Merge dataspace response

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

with:

Close a dataspace or snapshot

Close dataspace or snapshot request

Close dataspace request:

<m:closeBranch xmlns:m="urn:ebx-schemas:dataservices_1.0">
	<branch>String</branch>
	<deleteDataOnClose>boolean</deleteDataOnClose>
	<deleteHistoryOnClose>boolean</deleteHistoryOnClose>
</m:closeBranch>

Close snapshot request:

<m:closeVersion xmlns:m="urn:ebx-schemas:dataservices_1.0">
	<version>String</version>
	<deleteDataOnClose>boolean</deleteDataOnClose>
</m:closeVersion>

with:

Close dataspace or snapshot response

Close dataspace response:

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

Close snapshot request:

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

Operations on data workflows

Parameters for data workflows operations are retrieved from the SOAP header in the session.

Deprecated since version 5.7.0 to define parameters in the SOAP message body.

See session parameters for more information.

Start a workflow

Start a workflow from a workflow launcher. It is possible to start a workflow with localized documentation and specific input parameters (with name and optional value).

Sample request:

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

with:

Sample response:

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

with:

Resume a workflow

Resume a workflow in a wait step from a resume identifier. It is possible to define specific input parameters (with name and optional value).

Sample request:

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

with:

Sample response:

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

with:

End a workflow

End a workflow from its identifier.

Sample request:

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

with:

Sample response:

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

with: