Performance Center REST Web Services
The CA npc RESTful web services can programmatically perform the following tasks:
Performance CenterRESTful web services can programmatically perform the following tasks:
- Create and update user accounts
- Create containers for MSP customer sites ("tenants")
- Create and manage groups
- Import and export dashboards
- Manage data sources
- Create, edit, and delete SNMP profiles
- Create IP domain definitions, and associate them with tenants
- Provide lists of all configuration items, such as custom user accounts, roles, or groups, that are already in the system
Performance CenterWeb Services
API components are installed automatically with
CA Performance Management. Access the web services from a web browser. The launch page includes a list of the available web services, endpoint addresses, and WADL and WSDL URLs. The full list of all available web services for
Performance Centeris available at the following URL:
From this page, you can also access the WADL of each web service. If you use a testing utility to run web service calls, you receive feedback that is useful for debugging purposes. Using a testing utility is also a timesaver. You can supply username and password parameters as service endpoints for automatic authentication of all service calls.
Such utilities require a WSDL file that describes the service being tested. A WSDL file is an XML file that conforms to the Web Services Description Language. In the REST format, the simpler Web Application Description Language (WADL) is used instead. The CA
Performance CenterAPI launch page gives you access to a WADL file for each web service that you can use for testing. A link to the WSDL is provided for the SOAP web services.
Most web services provide their own documentation, including lists and descriptions of the available parameters and operations. The documentation is accessible in HTML format from the API launch page:
Connect a REST Client to
You can connect any REST client to
Follow these steps:
- Launch the REST client.
- Type a URL for the CAPerformance CenterRESTful web services API in the URL field. Use the following format:http://PC_host:8181/pc/center/webservice/Web_Service_NameFor example, to invoke the tenants web service, supply the following URL:http://PC_host:8181/pc/center/webservice/tenants/
- SelectGETfor theHTTP Method.
- SelectBasic Authenticationfrom theAuthenticationmenu.The Basic Authorization dialog opens.
- Type a valid username and password for a user account that has global administrator access, and clickOK.
- SelectCustom Headerfrom theHeadersmenu.TheRequest Headerdialog opens.
- TypeContent-Typeas the value for theNameparameter.
- Typeapplication/xmlin theValuefield, and clickOK.The Headers section now shows the following updated values:Authorization: Basic YWRtaW46YWR...Content-Type:application/xml
Endpoints and the XML Schema
All endpoints act on a common set of data. The data can be represented in different data formats (for example, MIME types). The format depends on the endpoint that consumes or produces the data. An XML schema describes the data and other supported data formats, such as JSON.
This documentation describes the basic terms and parameters of the XML schema to create scripts for the
Performance CenterRESTful web services. Data can be grouped by namespace. A schema describes the types and elements of each namespace.
Typesdefine the structure of the data, while
elementsare instances of a type. For example, elements are produced or consumed by a REST endpoint, and the structure of each element is described by its type.