This section provides the information necessary to access and use the Web Services API (WS API). The WS API currently supports SOAP protocol.
The WS API provides a programmatic way of interacting with the Service Desk platform. You can change data for entities such as Tickets, Configuration Items, and Knowledge Articles that are managed within the Service Desk application.
To use this document, basic familiarity with software development, webservices, and the Service Desk user interface is required. Any functionality that is described in this document is available only when your organization is granted Web Services access license.
If you cannot access the features you see in this document, contact Service Desk Support.
| Note |
|---|
| Note: We recommend using the SOAP UI client to interface with CA Cloud Service Management Web Services. Refer to http://www.soapui.org for more information about using SAOP UI client. |
This section contains the following topics:
...
The WS API is implemented to comply with the following standard specifications:
| Standard Name | Website |
| Simple Object Access Protocol (SOAP) 1.1 | http://www.w3.org/TR/2000/NOTE-SOAP-20000508/ |
| Web Service Description Language (WSDL) 1.1 | http://www.w3.org/TR/2001/NOTE-wsdl-20010315 |
Development Platforms
The API has been validated to work with J2EE 1.6 and Apache Axis2 development environments. In this document, we provide examples in Java. The Java examples are based on Apache Axis2 1.5.1 and JDK 1.6. For more information, see http://axis.apache.org/axis2/java/core/.
...
- You are a user that accesses the US Production instanceCSM3 or CSMStaging. Typically, you log in to https://sm1csm3.saasserviceaide.ca.com. To access the Service Request WSDL, you can access one of the following URLs:
- You are a user that accesses the US Staging instance. Typically, you log in to https://sm1s.saas.ca.com. To access the Service Request WSDL, you can access one of the following URLs:
Note: The exact URL depends on the instance that you are accessing. Contact the support team for the exact URL, or use the provided example to construct the URL.
...
- Update Client Class from existing/latest version of WSDL document.
- Compile & Run the Client Class.
Backward Compatibility
CA Cloud Serviceaide Intelligent Service Management does not ensure that an application written against one WS API version works with future API versions. Changes in method signatures and data representations are often required as we continue to enhance the API.
...