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 |
|
- Web Service Interfaces
- Reference information for all web services
- Action Web Service Interface
- Downtime Web Service Interface
- Event Synchronization Web Service Interface
- Event Web Service Interface
- Monitoring Automation Web Service Interface
- Status Web Service Interface
- Tool Execution Web Service Interface
- User Management Web Services Interface
Status Web Service Interface
The REST-based Status web service enables integrators to remotely retrieve health information (HIs and KPIs) for a CI.

To access the Status web service, use the following base URL and syntax:
|
|
<baseURL> |
The URL of the Status web service:
where |
<request> |
The service request. |

The Status web service interface supports the following requests:
Request | Request Type | Status Web Service Action |
---|---|---|
?filter=”ciId==<CI ID>”
|
GET |
Returns CI status and a list of KPIs for the CI specified by the < |
?filter=”ciName==<CI NAME>”
|
GET |
Returns CI status and a list of KPIs for the CI specified by the < |
?filter=”globalCiId==<GLOBAL CI ID>”
|
GET |
Returns CI status and a list of KPIs for the CI specified by the < |
?filter=”view==<VIEW NAME>”
|
GET |
Returns CI status and a list of KPIs for all CIs contained in a view specified by the < |
The following additional view parameters enable you to specify a predefined set of attributes to be included in the response:
&view=condense
|
GET |
Returns only CI status. |
&view=summary
|
GET |
Default. Returns CI status and a list of KPIs. |
&view=expand
|
GET |
Returns CI status, a list of KPIs, and a list of HIs. |

In order to operate the Status web service, a user must be assigned a role with the Service Health Rest permission. This permission enables the user to view CI Names and IDs (global and local) while using the status web service. To be able to use the <view name
> option, a user must have adequate permission on the view in the RTSM. For more information on permissions, see the
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 ovdoc-asm@hpe.com.
Help Topic ID:
Product:
Topic Title:
Feedback: