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
- List service requests for subscription
- List active requests for user
- Get count of requests for user
- Cancel multiple service requests
- Delete multiple service requests
- List approvals for approver
- Get count of approvals for user
- Delete multiple approval requests
- List subscriptions for user
- Get count of subscriptions for user
- Get list of recent or expiring soon subscriptions for user
- Get list of all components of a specific type for a specific user
- Delete multiple subscriptions
- List instances for user
- 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
User API
Use this API to get information related to users.
Base URL
https://<host>:<port>/csa/rest
URIs
The following URIs are appended to the base URL:
Request
A request is created whenever a user initiates, changes, or deletes a subscription.
URI | Method | Parameters | Description |
---|---|---|---|
/user/instance/<instance_id>/request | GET | userIdentifier | List service requests for subscription |
/user/myrequest | GET | userIdentifier, scope, detail, submitter, returnRetired, submitStartDate, submitEndDate | List active requests for user |
/user/request/count | GET | userIdentifier | Get count of requests for user |
/user/multipleRequest/cancel | POST | userIdentifier | Cancel multiple service requests |
/user/multipleRequest/delete | POST | userIdentifier | Delete multiple service requests |
Approval
An approval is created when the approval manager approves a request.
URI | Method | Parameters | Description |
---|---|---|---|
/user/approval/count | GET | userIdentifier | Get count of approvals for user |
/user/multipleApprovals/delete | POST | userIdentifier | Delete multiple approval requests |
/user/myapproval | GET | userIdentifier, scope, detail, returnRetired, approver, creationStartDate, CreationEndDate | List approvals for approver |
Subscription
A subscription is created when a consumer requests a service offering and includes all of the options selected by the consumer when the subscription was initiated.
URI | Method | Parameters | Description |
---|---|---|---|
/user/mysubscription | GET | userIdentifier, scope, detail, requestor, returnRetired, creationStartDate, creationEndDate, modificationStartDate, modificationEndDate | List subscriptions for user |
/user/subscription/count | GET | userIdentifier | Get count of subscriptions for user |
/user/subscription | GET | userIdentifier, queryType | Get list of recent or expiring soon subscriptions for user |
/user/multipleSubscription/delete | POST | userIdentifier | Delete multiple subscriptions |
Instance
An instance is created when a request is approved and includes details about the requested services such as the status of services, IP addresses, etc.
URI | Method | Parameters | Description |
---|---|---|---|
/user/myinstance | GET | userIdentifier, scope, detail, requestor, returnRetired, creationStartDate, creationEndDate | List instances for user |
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: