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 |
|
- Application Programming Interface
- Consumption APIs
- Legacy APIs
- Simplified API
- Retrieving Information using RESTful calls
- Sample use cases
- 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
- Deprecated APIs
Legacy APIs
These APIs use a REST interface. For information on REST interface, see http://en.wikipedia.org/wiki/Representational_state_transfer. This documentation assumes that you have prior knowledge of REST interfaces.
The base URL for a CSA REST API is https://<host:port>/csa/rest, which is appended with the specific URI for the API call. For example, to access the <example> API, use the URL: https://<host:port>/csa/rest/<example>
.
Because XML content passed into or returned by a REST API calls can be lengthy, example XML content presented in this document are abbreviated to include just the more pertinent XML content.
An authorization header must be included in all API requests.
Note Special or localized characters used in the URL of REST API calls must be encoded before they are sent to the server.
Tip You should only include one value for a Boolean property and the value must be either true or false.
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: