Web Services Reference

The Web Services Reference describes the methods made available through the Client Automation Web Service as described in the Client Automation Web Service WSDL (webserviceapi.wsdl), which is in the top level Client Automation install directory.

The Client Automation Web Service exposes a series of utility methods that enable you to perform some common Client Automation tasks. These methods are logically grouped as follows:

Authentication and Web Services Management
Deployment
Enterprise Distribution Functionalities
Queries
Software
Security
Units and Groups
OSIM
Health Monitoring
Automation Web Service

Each of the documented Web Service methods takes a session identifier as input. This session identifier is created when you log in to the Client Automation web service using the method Login. The session identifier is unique to each web service session and maintains information about an authenticated user.

The Web Service methods may also take as input Client Automation sequences and enumerations.

Notes:

Webservices related to DMdeploy, OSIM, Security Areas, Software jobs, Creation of Units and Automation Services are only applicable at Domain Manager.
Webservices related to Distributions and Domain Groups are only applicable at Enterprise Manager.
When you use a non UTF8 end point and an input parameter string contains non-English characters, the string should be converted to a UTF8 encoded string and then converted to an ISO-8859-1 encoded string before passing the input parameter to the WS API.
An asterisk (^m) indicates that the parameter is mandatory.
This Webservice API (webserviceapi.wsdl) is compliant with Microsoft® .NET Framework, Java Axis, and Gsoap toolkit.
The documentation for all Webservice APIs is according to the Client Automation Web Service WSDL file and not according to code generated by the client tool in use.
The service end point in WSDL (definitions\service\port\SOAP:address\location) is written as:
"http://<servername>/UDSM_R11_WebService/mod_gsoap.dll" (on Windows)
"http://<servername>/UDSM_R11_WebService" (on Linux)

The path is valid only if Default Web Site is listening on port 80 and SSL is not configured.

If the port number is not 80 or SSL is configured, the administrator has to modify the service end point in WSDL manually to comply with different port and SSL. For example, if port is changed to 5256, the service end point on Windows will be the following:

"http://<servername>:5256/UDSM_R11_WebService/mod_gsoap.dll"

If SSL is configured, use https instead of http.
All the WS APIs corresponding to CO & AM component, take/return DateTime structure as GMT. All the WS APIs corresponding to SD component, take/return DateTime structure in the time zone of the manager machine.

This section contains the following topics:

DSM Web Services End Point for UTF-8 Strings

Automation Web Services End Point

Configuration Parameters

SSL Configuration

Passing System Defined Groups as Parameters

DSM Web Services End Point for UTF-8 Strings

Client Automation provides a WSDL and an end point for UTF-8 strings. The new WSDL and end point are available in addition to the existing WSDL and end point. Following are the new WSDL and end point that enable DSM web services to accept or return UTF-8 strings:

WSDL: webserviceapi_utf8.wsdl

End point: http://<hostname>/DSM_Webservice/mod_gsoap_utf8.dll

You can access the new WSDL that points to the new end point using http://<hostname>/DSM_Webservice/wsdl

Automation Web Services End Point

You can access the Automation Service URI and WSDL from the following locations:

AutomationService URI - http://<hostname>:[tomcat port number]/axis/services/automationService
AutomationService WSDL - http://<hostname>:[tomcat port number]/axis/services/automationService?wsdl

In addition, the Automation Service WSDL file is available at the following location:

<DSM Installed folder>\webservices\wsdl\addons\AutomationService.wsdl