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 |
|
Entity path
In an outbound JSON request, entity path is the path above the endpoint field defined in the field mapping.
For example, in a Case Exchange integration instance, all endpoint fields are defined as properties.**** in the field mapping. The following example is an outbound request body in the endpoint:
{
"entities": [{
"properties": {
"DisplayLabel": "Create New Incident",
"Description": "create the new incident record",
"ImpactScope": "MultipleUsers",
"Urgency": "SlightDisruption",
"Solution": "",
"Id": "IM118216"
},
"ext_properties": {
"Operation": "Update",
"ExternalStatus": "Open",
"ExternalId": "IM45167",
"ExternalSystem": "SM",
"ExternalEntityType": "Incident"
},
"Comments": [{
"Body": "IM45167",
"CreatedTime": 1402038076398
}],
"entity_type": "Incident"
}]
}
In this particular example, one of the endpoint fields is properties.Displaylabel, so the entity path is entities[0].
Note RESTful protocols other than JSON are not supported.
