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 |
|
- Catalog API
- List catalogs
- Get catalog details
- Create catalog categories
- Update catalog categories
- Delete catalog category
- List offerings in the catalog
- Get offering details
- Submit a request
- Get request details
- Cancel a request
- Retire a request
- Get approval details
- Update approval decision using an external approval system
- Update approval decision using CSA approval process
- Update catalog approval policies
- Update service offerings approval policy
- Get subscription details
- Get instance details
- Retire an approval
- Get resource subscription details
Get instance details
Details
| URI | /catalog/<catalog_id>/instance/<instance_id> Use Catalog API to get the catalog ID and List instances in the catalog to get the instance ID. |
|---|---|
| Method | GET |
| Parameters |
Required; the user ID you want to use as credentials for this API call. This user should be a consumer user who has the necessary permissions for the data you want to work with. See Get userIdentifier for the steps required to get the userIdentifier value.
Optional; default is base. If value is base, then the object is returned. If value is baseplusone, then the object and its first level children are returned. If value is subtree, then the object and all of its descendants are returned.
Optional; default is full. See Values for the detail parameter. Some API calls do not support all possible values for this parameter.
Optional; default is true. If the value is true, then the output fields of the REST response are restricted. By default, the following fields are not displayed: createdBy, updatedBy, createdOn, updatedOn, description, iconUrl, and categoryType. If the value is false, then the output fields are displayed. For more information, see Values for the restrict parameter |
| Returns | 200 - Ok 401 - Not authorized 404 - Not found 500 - Server exception |
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 clouddocs@hpe.com.
Help Topic ID:
Product:
Topic Title:
Feedback: