Search for	Example	Results
A single word	`cat`	Topics that contain the word "cat". You will also find its grammatical variations, such as "cats".
A phrase. You can specify that the search results contain a specific phrase.	`"cat food"` (quotation marks)	Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase.

Search for	Operator	Example
Two or more words in the same topic	`AND` `and` `+` (plus symbol) `&` (ampersand)	`cat AND dog` `"cat food"+milk` `"cat food"&"dog food"`
Either word in a topic	`OR` `or` `\|` (pipe)	`cat OR dog` `cat \| dog`
Topics that do not contain a specific word or phrase	`NOT` `not` `!` (exclamation point)	`NOT cat` `! dog`
Topics that contain one string and do not contain another	`^` (caret)	`cat ^ mouse`
A combination of search types	`( )` parentheses	`cat + (dog \| mouse)` `cat \| dog + (! mouse)`

Cloud Service Automation4.80.0002

Develop > Application Programming Interface > Legacy APIs

Legacy APIs

These APIs use a REST interface. For more information on REST interface, see http://en.wikipedia.org/wiki/Representational_state_transfer for general REST information. This documentation assumes that you have prior knowledge of REST interfaces.

The base URL for a CSA REST API is https://<host:port>/csa/rest, which is appended with the specific URI for the API call. For example, to access the <example> API, use the URL: https://<host:port>/csa/rest/<example>.

Because XML content passed into or returned by a REST API calls can be lengthy, example XML content presented in this document are abbreviated to include just the pertinent XML content.

An authorization header must be included in all API requests.

Note Special or localized characters used in the URL of REST API calls must be encoded before they are sent to the server.

Tip You should only include one value for a Boolean property and the value must be either true or false.

Send Help Center feedback