Methods

Important:

As with any REST API, the content transferred to the server is not encrypted. Therefore, it is imperative for security considerations to set up IXIASOFT CCMS Web with HTTPS.

URL Structure

All REST end-points are under <ccms_url>/rest/1.0, where <ccms_url> is the URL of your IXIASOFT CCMS installation.

For example: https://ccms.acme.com/ixiasoft-ccms/rest/1.0/<rest_endpoint>

Cookie

The login method returns a cookie "IxiaAuth" with a session ID, which must be passed to every other call in order to authenticate them and reuse the same session.

Request Body Format

For API methods using either PUT or POST, the request body content is formatted in JSON.

The request body always has a single field named data. The content of this field depends on each method and is documented with the method.

Response Body Format

The response body content is formatted in JSON.

The response always contains four fields: error, events, timers and result.

error

The error field always contains two fields, code and message.

A successful call has the code "0" and the message "Successful call"

events

This field contains the list of events for the transaction. If the action resulted in an error, the events will provide the details.

timers

This field is for internal usage.

result

The result field contains the actual result of the operation, and its content depends on the method. It is documented with each method.