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 |
|
Enable a Resource for REST
To enable a resource to use the RESTful API Framework, follow these steps:
-
Navigate to Tailoring > Web Services > Web Service Configuration.
-
If needed, enter the information in the Service Name, Name, or Object Name fields to specify the resource you want to enable for RESTful.
-
Click Search, and then select the appropriate resource from the list.
-
Under External Access Definition, click the RESTful API tab.
-
Check the RESTful Enabled? check box.
-
Specify the following required fields:
Field Function 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. -
If needed, specify the following additional fields:
Field Function Resource Collection Action
POST:
This field represents the default action for resource collection. Resource Actions
POST:
PUT:
DELETE:
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.
