Unicenter Asset Portfolio Management Web Service Updates.

Document ID : KB000052862
Last Modified Date : 14/02/2018
Show Technical Document Details

Description:

The purpose of this document is to provide a summary of updates introduced in Web Service interface of UAPM 11.3.4 with from GA release till Cumulative-4 (RO10165) and T5NE109. These updates are also applicable for any future published maintenance released after RO10165.

Solution:

Overview:

The Unicenter Asset Portfolio Management Web Service provides an XML based services to read, update, create and delete Unicenter APM data in your repository. Any changes in the web service interface might cause an existing client program to fail in any of these tasks. So, please go through this document to figure out if any of your already existing Web Service calling programs are needed to be modified.

UAPM Web Service Updates:

You can access the Web Services with the following URL:
http://<servername>/apmws/uapm.asmx.
You are then presented with uapm operations that are supported for the listed processes.

The interface of the Web method getListNamesAndIDS has been changed. The messageName for it is now changed to "Returns_x0020_all_x0020_List_x0020_IDs_x0020_and_x0020_List_x0020_Names" and the SOAPAction for it is also changed to "Returns all List IDs and List Names". All the web service calling programs are needed to be modified to execute it correctly if it is using this method for performing any tasks. The functionality of this method is still the same and it returns set of all list values and ListIDs.

With these changes the SOAP packet format has also been modified. Below are the updated sample SOAP 1.1 and 1.2 requests and responses for this method. The placeholders shown (in bold) need to be replaced with actual values.

SOAP 1.1

Request

POST /APMWS/uapm.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/uapmws/uapm/Returns all List IDs and List Names"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header>
<AuthHeader xmlns="http://tempuri.org/uapmws/uapm">AuthHeader</AuthHeader>
</soap:Header>
<soap:Body>
<Returns_x0020_all_x0020_List_x0020_IDs_x0020_and_x0020_List_x0020_Names xmlns="http://tempuri.org/uapmws/uapm">
<loginToken>string</loginToken>
</Returns_x0020_all_x0020_List_x0020_IDs_x0020_and_x0020_List_x0020_Names>
</soap:Body>
</soap:Envelope>

Response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header>
<AuthHeader xmlns="http://tempuri.org/uapmws/uapm">AuthHeader</AuthHeader>
</soap:Header>
<soap:Body>
<Returns_x0020_all_x0020_List_x0020_IDs_x0020_and_x0020_List_x0020_NamesResponse xmlns="http://tempuri.org/uapmws/uapm">
<Returns_x0020_all_x0020_List_x0020_IDs_x0020_and_x0020_List_x0020_NamesResult>xml
</Returns_x0020_all_x0020_List_x0020_IDs_x0020_and_x0020_List_x0020_NamesResult>
</Returns_x0020_all_x0020_List_x0020_IDs_x0020_and_x0020_List_x0020_NamesResponse>
</soap:Body>
</soap:Envelope>

SOAP 1.2

Request

POST /APMWS/uapm.asmx HTTP/1.1
Host: localhost
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Header>
<AuthHeader xmlns="http://tempuri.org/uapmws/uapm">AuthHeader</AuthHeader>
</soap12:Header>
<soap12:Body>
<Returns_x0020_all_x0020_List_x0020_IDs_x0020_and_x0020_List_x0020_Names xmlns="http://tempuri.org/uapmws/uapm">
<loginToken>string</loginToken>
</Returns_x0020_all_x0020_List_x0020_IDs_x0020_and_x0020_List_x0020_Names>
</soap12:Body>
</soap12:Envelope>

Response

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Header>
<AuthHeader xmlns="http://tempuri.org/uapmws/uapm">AuthHeader</AuthHeader>
</soap12:Header>
<soap12:Body>
<Returns_x0020_all_x0020_List_x0020_IDs_x0020_and_x0020_List_x0020_NamesResponse xmlns="http://tempuri.org/uapmws/uapm">
<Returns_x0020_all_x0020_List_x0020_IDs_x0020_and_x0020_List_x0020_NamesResult>xml
</Returns_x0020_all_x0020_List_x0020_IDs_x0020_and_x0020_List_x0020_NamesResult>
</Returns_x0020_all_x0020_List_x0020_IDs_x0020_and_x0020_List_x0020_NamesResponse>
</soap12:Body>
</soap12:Envelope>

Note: SOAPAction as well as tags under SOAP body have been modified.

Summary:

All the custom programs which make calls to getListNamesAndIDS method of the UAPM web service are needed to check once for correct SOAP packet format as displayed previously in the samples. Also the parsing logic of the response packet is also changed so it is also needed to verify that the program is functioning properly. Please contact CA support for any further assistance or clarification.