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 |
|
- Legacy APIs
- Artifact API
- Availablevalues API
- Catalog API
- Export API
- Import API
- Import_result API
- Lifecycle engine API
- Login API
- Notification API
- Organization API
- orgInformation API
- Processinstances API
- Resource Provider API
- Search API
- User API
- Utilization API
- Values for the detail parameter
- Values for the excludedoc parameter
- Values for the scope parameter
- Values for the restrict parameter
- Primitive values reset to default
Values for the detail parameter
The detail parameter has the following values:
- Required: Retrieves all the non-null and non-optional fields of an artifact. This includes fields with Java primitive types – byte, short, int, long, float, double, boolean and char.
- Basic: In addition to the Required fields of an artifact, retrieves nullable primitive types (Java wrapper classes) and Date, Time, TimeStamp and BigDecimal.
- Standard: In addition to the Basic fields of an artifact, retrieves all non-CSA type fields.
- Template: Retrieves all fields of an artifact except for artifact collection references and artifacts that are part of a containment relationship. This is same as the Full option without artifact collection references. This option is mainly used for performance reasons, because you could end up retrieving a large amount of data. For example, you can use this option if you do not want to load the base service instances when retrieving its service blueprint. Service instances are artifacts and are associated through a collection reference with its blueprint.
- Full: All fields except for artifacts that are part of a containment relationship. Retrieval of the internal artifacts is controlled by the scope parameter. Using this option has a performance impact (See Template option) because this option also returns artifact collection references.
Note Some API calls do not support all possible values for this parameter.
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: