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
- Artifact types
- Create an artifact
- View an artifact
- Update an artifact
- Delete an artifact
- Retrieve a predefined view for an artifact
- Retrieve resolved properties for an artifact
- List active groups associated with an organization
- Add groups to an organization
- Update group display name, distinguished name
- Delete or disassociate group from an organization
- List resource providers
- Add document to service offering
- Delete document from service offering
- Update document in service offering
- Publish service offerings to catalog
- Unpublish service offerings from catalog
- Retrieve artifact state and status
- Artifact views
- 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
- Artifact API
Artifact API
Use this API to view, create, and modify artifacts.
Base URL
https://<host>:<port>/csa/rest
URIs
The following URIs are appended to the base URL:
Artifact
URI | Method | Parameters | Description |
---|---|---|---|
/artifact | POST | userIdentifier |
|
/artifact/<artifact_id> | GET | userIdentifier, scope, detail, view |
|
/artifact/<artifact_id> | PUT | userIdentifier, scope, view |
|
/artifact/<artifact_id> | DELETE | userIdentifier |
|
/artifact/fastview/<artifact_id> | GET | userIdentifier, view |
|
/artifact/<artifact_id>/resolveProperties | GET | userIdentifier, propertyName |
|
Group
URI | Method | Parameters | Description |
---|---|---|---|
/artifact/<organization_id>/group | GET | userIdentifier |
|
/artifact/<organization_id>/group | POST | userIdentifier |
|
/artifact/<organization_id>/group/<grou_id> | PUT | userIdentifier |
|
/artifact/<organization_id>/group/<group_id> | DELETE | userIdentifier |
|
Resource Provider
URI | Method | Parameters | Description |
---|---|---|---|
/artifact | GET | userIdentifier, artifactType |
|
Service Offering
URI | Method | Parameters | Description |
---|---|---|---|
/artifact/<service_offering_id>/document | POST | userIdentifier |
|
/artifact/<service_offering_id>/document | DELETE | userIdentifier |
|
/artifact/<service_offering_id>/document/<document_id> | POST | userIdentifier |
|
/artifact/<catalog_id>/publish | POST | userIdentifier |
|
/artifact/<catalog_id>/unpublish | POST | userIdentifier |
|
Note You can view information about an artifact with GET /artifact/<artifact_id> or GET /artifact/fastview/<artifact_id>. The fastview API can traverse associations, while the standard artifact API only returns information for the artifact.
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: