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.
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. |
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 |
|
- Reference
- Authenticate
- Availability Information
- Sample Data Model
- Insert Topology
- Get CI
- Update CI
- Delete CI
- Generate Change Report
- Get Related CIs
- Get Relation
- Update Relation
- Delete Relation
- Get Protocol
- Sample Topology Query
- Execute Query By Name
- Execute Query By Definition
- Expose CI Information
- Get Chunked Query Result
- Delete Chunked Query Result
- Run Impact Analysis
- Multiple CMDB Calls
- History Changes
Availability Information
Provides information about REST API services availability.
URL
/ping
Method
GET
Headers
None
Request type
None
Response type
Text
URL Parameters
Required:
None
Optional:
restrictToReader
: [boolean] - only returns available status if the server is in reader mode, if the server is writer return UNAVAILABLE status
restrictToWriter
: [boolean] - only returns available status if the server is in writer mode, if the server is reader return UNAVAILABLE status
Payload
None
Success response
Code: 200
Content: Up, writer: [boolean]
Error response
Code: 503
Content: Down
Notes
None
We welcome your comments!
To open the configured email client on this computer, open an email window.
Otherwise, copy the information below to a web mail client, and send this email to cms-doc@microfocus.com.
Help Topic ID:
Product:
Topic Title:
Feedback: