Virtual Automation API Guide › About the Virtual Automation API › Virtual Automation API Structure

Virtual Automation API Structure

All resource URIs for the virtual API have a defined structure, as illustrated in the following example:

https://hostname:8443/rest/am/1/collectionprofiles

The first part of the URI identifies the target server. Replace "hostname" with the name of the CA User Activity Reporting Module server you want to contact.

The second part of the URI, "/rest/am/1" is common to all the resources on that server. The “1” specifies the version of the API you want to access.

The third element defines the resource you want to access, in this case “/collectionprofiles”.

You can return data or send data in either XML or JSON format. To specify data return format, include values in the HTTP Accept header to specify which you format you want:

• "Accept: application/xml"
• "Accept: application/json"

To specify sent the format of data you send using PUT or POST, use the HTTP Content-Type header:

• "Content-Type: application/xml"
• “Content-Type: application/json”

Note: All API examples in this guide are shown using the cURL command line HTTP client.