Searching the Help
To search for information in the Help, type a word or phrase in the Search box. When you enter a group of words, OR is inferred. You can use Boolean operators to refine your search.
Results returned are case insensitive. However, results ranking takes case into account and assigns higher scores to case matches. Therefore, a search for "cats" followed by a search for "Cats" would return the same number of Help topics, but the order in which the topics are listed would be different.
Words and Phrases
| 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. |
Using Boolean Operators
| Search for | Operator | Example |
|---|---|---|
|
Two or more words in the same topic |
|
|
| Either word in a topic |
|
|
| Topics that do not contain a specific word or phrase |
|
|
| Topics that contain one string and do not contain another | ^ (caret) |
cat ^ mouse
|
| A combination of search types | ( ) parentheses |
|
RESTful Commands
The Rest API Framework supports the following HTTP commands:
GET
POST
PUT
DELETE
The functionality of these commands varies according to the type of object to which it is applied and the actions that are associated with that object. The following table shows example resources and illustrates how these commands are used:
| Object | Example Commands | Result |
|---|---|---|
| Service Document | GET / |
Returns all accessible URLs. |
| Query | GET/<incidents> |
Returns all Incidents |
GET/<incidents>/<id> |
Returns an Incident with the specified ID. | |
GET/<incidents>?query=<url-encoded-string>&sort=number:ascending |
Returns a subset of Incidents as specified by the URL encoded string, in ascending order. | |
| Resources with Actions | POST /<incidents> |
Creates an Incident |
PUT /<incidents>/<id> |
Updates an specific Incident | |
POST /<incidents>/<id>/action/<action> |
Invokes a customized action on a specific Incident |
