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 |
|
A Usage Example
This example demonstrates how to make a POST call to execute a TQL query by definition to return the name of all CPUs of which the attribute contains Pentium
.
Step 1. Retrieve the authentication token
To do this, make a POST call to https://localhost:8443/rest-api/authenticate with the following payload:
{ "username": "sysadmin", "password": "Sysadmin?123", "clientContext": 1 }
Note This example assumes that the REST API is deployed at the following location:
https://localhost:8443/rest-api
You then receive a response that resembles the following:
Status: 200 Response body: { "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE0NzQzNTc3MDYsImN1c3RvbWVyIjoxLCJ1c2VybmFtZSI6InN5c2FkbWluIn0.cVYsuum1CqaqfZV1K5KJ8nidOOif8Wv9tZsLFFZPbSs" }
Step 2. Make a POST call to run the TQL query
Make a POST call to https://localhost:8443/rest-api/topologyQuery with the following payload:
{ "nodes": [ { "type": "cpu", "queryIdentifier": "cpu1", "visible": true, "includeSubtypes": true, "layout": ["name"], "attributeConditions": [{ "attribute": "name", "operator": "like", "value": "%Pentium%" }], "linkConditions": [] }], "relations": [] }
At the same time you need to set the following header:
Authorization Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE0NzQzNTc3MDYsImN1c3RvbWVyIjoxLCJ1c2VybmFtZSI6InN5c2FkbWluIn0.cVYsuum1CqaqfZV1K5KJ8nidOOif8Wv9tZsLFFZPbSs
Note The payload specifies the layout
attribute to name
, so that the CPU name will be returned.