The AP web service API utilizes a REST (Representational State Transfer) architecture. This means that your client programs perform various operations by issuing the HTTP methods named GET, PUT, POST, and OPTIONS against a well-defined hierarchy of URIs (Universal Resource Identifiers) that represent CA Automation Point objects. These URIs are like the URIs that you type into your browser (similar to http://www.ca.com). AP web service URIs are specific to a given CA Automation Point server. These URIs are accessible only to that portion of your corporate network that can access your CA Automation Point server.
We have defined a set of URIs that represent meaningful CA Automation Point objects which you can manipulate. CA has also defined which HTTP methods can be issued against a given URI, and what operation each method actually performs against the related object.
The RESTful HTTP operations include an attached XML payload containing parameters that are associated with the desired operation. Similarly, the replies that you receive and your error results are delivered in XML documents. The XML reply document can be parsed to process detailed results from your request. Different XML documents apply to each specific HTTP method, issued against a specific CA Automation Point URI.
These concepts must be understood, to use the web service API effectively.
The remainder of this chapter is dedicated to answering exactly those questions.
|
Copyright © 2014 CA Technologies.
All rights reserved.
|
|