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.
![Closed](../../../Skins/Default/Stylesheets/Images/transparent.gif)
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. |
![Closed](../../../Skins/Default/Stylesheets/Images/transparent.gif)
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
Export API
Use this API to export a supported artifact as a content archive. Supported artifacts include resource environments, resource offerings, service designs, service offerings, and catalogs.
Base URL
https://<host>:<port>/csa/rest
Details
URI | /export/<artifact_id>
|
---|---|
Method | GET |
Parameters |
Required; the user ID you want to use as credentials for this API call. See Get userIdentifier for the steps required to get the userIdentifier value. |
Returns | 200 - Ok 401 - Not authorized 404 - Object not found 500 - Server exception |
Note that the directory the archive will be downloaded to is defined by the REST client or browser in use.
Artifact archives are structured as following.
- Resource environment archive contains:
- Resource environment XML
- Manifest XML
- Resource offering archive contains:
- Resource offering XML
- Icons used for customizing resource offering
- Manifest.XML
- Service design archive contains:
- Service design XML
- Resource offering XMLs
- Icons used for customizing resource offerings and service design
- Dynamic option JSP files
- Manifest XML
- Service offing archive contains:
- Service offering XML
- Service design XML
- Resource offering XMLs
- Icons used for customizing service offering, service design, and resource offerings
- Dynamic option JSP files
- Manifest XML
- Catalog archive contains:
- Catalog XML
- Service offering XMLs
- Service design XMLs
- Resource offering XMLs
- Resource environment XMLs
- Icons used for customizing catalog, service offerings, service designs, and resource offerings
- Dynamic option JSP files
- Manifest XML
- Component palette archive contains:
- Component palette XML
- Service component type XMLs
- Service component template XMLs
- Resource offering type XMLs
- Artifact relationship XMLs
- Icon used for customizing component palette, service component types and templates
- Manifest XML
Example
The following URL was sent to export a catalog:
https://<host>:<port>/csa/rest/export/8a81818f3d02fb7e013d0308894a0004
?userIdentifier=90d96588360da0c701360da0f1d5f483
The following response headers were returned, and include the name of the downloaded archive zip file, CATALOG_QA_Org_Catalog_8a81818f3d02fb7e013d0308894a0004.zip:
Status Code: 200 OK
Cache-Control: must-revalidate, post-check=0, pre-check=0
Content-Disposition: attachment;filename="CATALOG_QA_Org_Catalog_8a81818f3d02fb7e013d0308894a0004"
Content-Type: application/zip;charset=UTF-8
Date: Tue, 26 Feb 2013 00:09:36 GMT
Expires: 0
Pragma: public
Server: Apache-Coyote/1.1
Transfer-Encoding: chunked
content-transfer-encoding: binary
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: