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 |
|
Configuration
The REST API can be configured by the rest_api.properties file, which is located in the following folder:
- Embedded: <UCMDB_Server_Home>/conf/
- Standalone: $CATALINA_HOME/conf/
The available options and default values are as follows:
#hostname of ucmdb server ucmdb_host=localhost #protocol to be used when connecting to ucmdb server(http or https) ucmdb_protocol=http #port of ucmdb server ucmdb_port=8080 #default ucmdb customer default_customer=1 #rest authorization token lifespan token_expiration_minutes=30
Note If the rest_api.properties file is not present in the above location, the REST API uses these default values.
For the embedded deployment, the REST API supports the HTTP and HTTPS protocols. You can choose a protocol by changing the value of the Rest-Api Port Mapping setting, which locates under UCMDB UI > Administration > Infrastructure Settings Manager > Web Components to Connectors.
For the standalone deployment, you can configure the REST API to run on HTTP or HTTPS by following the Tomcat documentation.
Note
-
There is a global limit of 15 requests/second for all the REST endpoints.
All the REST endpoints for the Changes Repots (/changes/*) are limited to 5 concurrent requests.
-
Input dates checking validates the date interval that is sent to the rest-api/changeReports endpoint, namely the dateFrom and dateTo fields of the request body:
- The dateTo field value can no longer occur 5 days after current time in the future.
- The dateFrom field value cannot occur after dateTo.
- The dateFrom field value cannot be longer than history.purging.months.to.save.back (UCMDB setting, default value 3) months in the past.
