Web Services API Documentation and Examples for APM

Products

• CA Service Management - Asset Portfolio Management
• CA IT Asset Manager
• CA IT Asset Manager Asset Portfolio Management

Issue/Introduction

CA Asset Portfolio Management (CA APM) also known as IT Asset Manager (ITAM) contains a web services function which lets you use a standards-based interface to build client applications that integrate with CA APM. 

The CA APM web services let you create, search, update, copy, and delete CA APM objects from your external client application. The assigned user role determines whether you have permission to access the web services in CA APM and also restricts the objects and data (classes and attributes) that can be viewed or modified.

The CA APM web services use the Web Services Description Language (WSDL) as the XML-based language for describing the services.

Environment

CA Asset Portfolio Management 17.3 and higher

Resolution

The CA APM web services let you access specific product operations (methods).  To download the WSDL, you will need to login to the APM UI and access the Administration tab, then the Web Services sub-tab, and then the "WSDL Download" link:

Note: CA APM uses the ticket ID to validate the user session. The ticket ID is contained in the SOAP header. With .NET clients, the client sets the SOAP header data in the client-side object when the user invokes the Login method. In other programming languages, the user must extract the SOAP header data and set it in each of the service calls. 

Method Name    Description

Login                   Logs in to the application.
Logout                 Logs out of the current user session.
Create                 Creates new objects in CA APM. Required attributes must be set. You do not need to provide a primary key for a non-linking object, since the product generates the key.
Update                Modifies (updates) existing CA APM objects that were obtained from the Search method. You must provide primary keys.
Delete                 Removes (deletes) existing CA APM objects that were obtained from the Search method. You must provide the version number and primary key attributes to complete the deletion.
Search                Retrieves existing CA APM objects based on your search criteria.
Copy                   Creates a new object in CA APM by copying all values from an existing object (source) and overriding the updated values.

See the attached document for APM web services examples using SOAP and .NET.

Additional Information

The above sample content is provided "as-is" and has not been tested or certified for use in production.  Support is not permitted to debug or troubleshoot any custom code developed as a result of the content provided in this article.  Support is not permitted to assist in porting the content provided for use in any other platforms.

The above is also the only available web services interface available for ITAM.  Other web services, such as the ImportService used in PAM integration (link), is not available for custom code development.