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 tab field definitions
Use this tab to enter the RESTful API related configurations.
| Field | Description |
|---|---|
| RESTful Enabled | If it is selected, RESTful API is available for this service. If it is not selected, RESTful API is unavailable for this service. |
| Attachment Enabled | If it is selected, attachment is supported by RESTFful API for this service. If it is not selected, attachment is not supported by RESTful API for this service. |
| Resource Collection Name | This is the name of the Resource Collection. For example, you may specify the group of incidents from the probsummary table as "incidents". |
| Resource Name | This is the name of the individual Resource. For example, you may specify that any individual incident from the probsummary table be referred to as an "Incident". |
| Unique Keys | This field specifies one or more fields that will function as a unique identifier for a Resource from the Resource Collection. For example, {ID} in single resource query URI, http://<server>:<port>/SM/9/rest/incidents/{ID} |
| Max Records Returned in Query | This is the max number of records returned in every single query when the number of records is huge. By default, the value is 1000. |
| Query Authorization | This is the query privilege for this service. |
| Resource Collection Action | This field represents the default action for resource collection. |
| Resource Actions | This field specifies the action to take when an individual resource is part of a POST, PUT, DELETE command. These actions are specified in the Allowed Actions tab of the External Access Definition. |
