EBX5

Documentation > Reference Manual > Integration > Data services > SOAP / WSDL

Navigation modeDocumentation > Reference Manual > Integration > Data services > SOAP / WSDL

WSDL generation

Section contents

Supported standard
Operation types
Supported access methods
WSDL download from the data services user interfaces
WSDL download using a HTTP request

Supported standard

EBX5 generates a WSDL that complies with the W3C Web Services Description Language 1.1 standard.

Operation types

A WSDL can be generated for different types of operations:

Operation type	WSDL description
`custom`	WSDL for EBX5 add-ons.
`dataset`	WSDL for dataset and replication operations.
`directory`	WSDL for default EBX5 directory operations. It is also possible to filter data using the `tablePaths` or `operations` parameters.
`repository`	WSDL for dataspace or snapshot management operations.
`tables`	WSDL for operations on the tables of a specific dataset.
`userInterface`	Deprecated since version 5.8.1. This operation type has been replaced by `administration`. While the user interface management operations are still available for backward compatibility reasons, it is recommended to no longer use this type. WSDL for user interface management operations (these operations can only be accessed by administrators).
`administration`	WSDL for administration operations like: user interface management These operations can only be accessed by administrators.
`workflow`	WSDL for EBX5 workflow management operations.

Supported access methods

EBX5 supports the following downloading methods:

From the data services user interface
From an HTTP request

A WSDL can only be downloaded by authorized profiles:

Operation type	Access right permissions
`custom`	All profiles, if at least one web service is registered.
`dataset`	All profiles.
`directory`	All profiles, if the following conditions are valid: No specific directory implementation is used. (The built-in Administrator role is only subject to this condition). Global access permissions are defined for the administration. 'Directory' dataset permissions have writing access for the current profile.
`repository`	All profiles.
`tables`	All profiles.
`userInterface`	Deprecated since version 5.8.1. This operation type has been replaced by `administration`. While the user interface management operations are still available for backward compatibility reasons, it is recommended to no longer use this type. Built-in administrator role or delegated administrator profiles, if all conditions are valid: Global access permissions are defined for the administration. 'User interface' dataset permissions have writing access for the current profile.
`administration`	Built-in administrator role or delegated administrator profiles, if all conditions are valid: Global access permissions are defined for the administration. 'Administration' dataset permissions have write access for the current profile.
`workflow`	All profiles.

WSDL download from the data services user interfaces

An authorized user can download an EBX5 WSDL from the data services administration area.

Note

See Generating a WSDL for dataspace operations in the user guide for more information.

WSDL download using a HTTP request

An application can download an EBX5 WSDL using an HTTP GET or POST request. The application has to be authenticated using a profile with appropriate rights.

Request details

HTTP(S) URL format:
http[s]://<host>[:<port>]/ebx-dataservices/<pathInfo>?<key - values>
Both <pathInfo> and <key - values> are mandatory. For more information on possible values see: Request parameters. An HTTP code is always returned, errors are indicated by an error code above 400.

HTTP(S) response status codes:

Status code	Information
`200` (OK)	The WSDL content was successfully generated and is returned by the request (optionally in an attachment).
`400` (Bad request)	The request is incorrect. This occurs when: A request element is incorrect. The unicity check on table names contains at least one error.
`401` (Unauthorized)	Request requires an authenticated user.
`403` (Forbidden)	Request is not allowed for the authenticated user.
`405` (Method not allowed)	Request is not allowed in this configuration.
`500` (Internal error)	Request generates an error (a stack trace and a detailed error message are returned).

Note

A detailed error message is returned for the HTTP response with status code 4xx.

HTTP(S) parameters size restrictions:

Request type	Information
GET	2048 octets or more (HTTP Protocol Parameters). Note: Servers ought to be cautious about depending on URI lengths above 255 bytes, because some older client or proxy implementations might not properly support these lengths.
POST	2 mega octets or more (depending on the servlet/JSP container). Each parameter is limited to a value containing 1024 characters.

Request type

Information

GET

2048 octets or more (HTTP Protocol Parameters).

Note: Servers ought to be cautious about depending on URI lengths above 255 bytes, because some older client or proxy implementations might not properly support these lengths.

POST

2 mega octets or more (depending on the servlet/JSP container). Each parameter is limited to a value containing 1024 characters.

Request parameters

A request parameter can be specified by one of the following methods:

a path info on the URL (recommended)
key values in a standard HTTP parameter.

For more detail, refer to the following table (some parameters do not have a path info representation):

Parameter name	As path info	As key - values	Required	Description
`WSDL`	no	yes	yes	Used to indicate the WSDL download. Empty value.
`login`	no	yes	no	A user identifier. Required when the standard authentication method is used. String type value.
`password`	no	yes	no	A password. Required when the standard authentication method is used. String type value.
`type`	yes	no	yes	An operation type. Possible values are: `custom`, `dataset`, `directory`, `administration`, `userInterface`, `repository`, `tables` or `workflow`. String type value.
`branch` `version`	yes	yes	(*)	A dataspace or a snapshot identifier. (*) required for `tables` and `dataset` types, otherwise ignored. String type value.
`instance`	yes	yes	(*)	A dataset identifier. String type value.
`tablePaths`	no	yes	no	A list of table paths. Optional for `tables` or `directory` types, otherwise ignored. If not defined, all tables are selected. Each table path is separated by a comma character. String type value.
`operations`	no	yes	no	Allows generating a WSDL for a subset of operations. Optional for `tables` or `directory` operation types, otherwise ignored. If not defined, all operations for the given type are generated. This parameter's value is a concatenation of one or more of the following characters: C = Count record(s) D = Delete record(s) E = Get credentials G = Get changes I = Insert record(s) U = Update record(s) R = Read operations (equivalent to CEGS) S = Select record(s) W = Write operations (equivalent to DIU) String type value.
`namespaceURI`	yes	yes	(**)	Unique name space URI of the custom web service. (**)Is required when `type` parameter is set to `custom` types. Otherwise is ignored. URI type value.
`attachmentFilename`	no	yes	(***)	The attachment file name. (***) optional if `isContentInAttachment` parameter is defined and set to `true`. Otherwise is ignored. String type value.
`isContentInAttachment`	no	yes	no	If value is `true`, the WSDL is downloaded as an attachment. Boolean type value. Default value is `false`.
`targetNamespace`	no	yes	no	Overrides the target namespace URI of the WSDL. URI type value, default value corresponds to `urn:ebx:ebx-dataservices`.

Request examples

Some of the following examples are displayed in two formats: path info and key - values.

The WSDL will contain all repository operations.
http[s]://<host>[:<port>]/ebx-dataservices/repository?WSDL&login=<login>&password=<password>
The WSDL will contain all workflow operations.
http[s]://<host>[:<port>]/ebx-dataservices/workflow?WSDL&login=<login>&password=<password>
The WSDL will contain all tables operations for the dataset 'dataset1' in dataspace 'dataspace1'.
Path info
http[s]://<host>[:<port>]/ebx-dataservices/tables/dataspace1/dataset1?WSDL&login=<login>&password=<password>
Key - values
http[s]://<host>[:<port>]/ebx-dataservices/tables?WSDL&login=<login>&password=<password>&branch=<dataspace1>&instance=<dataset1>
The WSDL will contain all tables with only readable operations for the dataset 'dataset1' in dataspace 'dataspace1'.
Path info
http[s]://<host>[:<port>]/ebx-dataservices/tables/dataspace1/dataset1?WSDL&login=<login>&password=<password>&operations=R
Key - values
http[s]://<host>[:<port>]/ebx-dataservices/tables?WSDL&login=<login>&password=<password>&branch=dataspace1&instance=dataset1&operations=R
The WSDL will contain two selected tables operations for the data set 'dataset1' in dataspace 'dataspace1'.
Path info
http[s]://<host>[:<port>]/ebx-dataservices/tables/dataspace1/dataset1?WSDL&login=<login>&password=<password>&tablePaths=/root/table1,/root/table2
Key - values
http[s]://<host>[:<port>]/ebx-dataservices/tables?WSDL&login=<login>&password=<password>&branch=dataspace1&instance=dataset1&tablePaths=/root/table1,/root/table2
The WSDL will contain custom web service operations for the dedicated URI.
Path info
http[s]://<host>[:<port>]/ebx-dataservices/custom/urn:ebx-test:com.orchestranetworks.dataservices.WSDemo?WSDL&login=<login>&password=<password>
Key - values
http[s]://<host>[:<port>]/ebx-dataservices/custom?WSDL&login=<login>&password=<password>&namespaceURI=urn:ebx-test:com.orchestranetworks.dataservices.WSDemo

Documentation > Reference Manual > Integration > Data services > SOAP / WSDL

EBX5 Version 5.8.1 [1067]. Copyright © Orchestra Networks 2000-2017. All rights reserved.

Trademarks and brand names referred to in this web site relating to organizations other than Orchestra Networks are the property of those organizations and Orchestra Networks makes no claims to such property.