HP Cloud Service Automation For the Windows ® and Linux operating systems Software Version: 4.
Legal Notices Warranty The only warranties for HP products and services are set forth in the express warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. HP shall not be liable for technical or editorial errors or omissions contained herein. The information contained herein is subject to change without notice. Restricted Rights Legend Confidential computer software.
Documentation Updates The title page of this document contains the following identifying information: l Software Version number, which indicates the software version. l Document Release Date, which changes each time the document is updated. l Software Release Date, which indicates the release date of this version of the software. To check for recent updates or to verify that you are using the most recent edition of a document, go to: http://h20230.www2.hp.
Support Visit the HP Software Support Online web site at: http://www.hp.com/go/hpsoftwaresupport This web site provides contact information and details about the products, services, and support that HP Software offers. HP Software online support provides customer self-solve capabilities. It provides a fast and efficient way to access interactive technical support tools needed to manage your business.
API Reference Contents Contents Contents 5 HP CSA 4.
API Reference Contents URIs 43 Catalog 43 Category 43 Offering 43 Request 44 Approval 44 Approval policy 45 Subscription 45 Resource Subscription 45 Instance 45 List catalogs 46 Get catalog details 48 Create catalog categories 49 Update catalog categories 51 Delete catalog category 52 List offerings in the catalog 53 Get offering details 54 List requests in the catalog 55 Deprecation Notice 55 Submit a request 57 Get request details 59 Cancel a request 62 Retire
API Reference Contents Deprecation Notice 70 Get subscription details 71 List instances in the catalog 73 Deprecation Notice 73 Get instance details 74 Retire an approval 74 Get resource subscription details 75 Export API 76 Import API 78 Importzip API 80 Deprecation Notice 80 Import_result API 82 Lifecycle engine API 84 Get details for a lifecycle execution record 84 Get latest lifecycle execution record for a service instance 86 Schedule lifecycle transition for service inst
API Reference Contents Delete approval policy 107 Retrieve organization LDAP access point information 108 List most requested, recently requested, or new offerings 109 orgInformation API 110 Processinstances API 111 URIs 111 Process Instance structure 112 Retrieve a process instance 113 Create a process instance 114 Update a process instance 116 Execute a process instance 118 Search API 119 User API 119 URIs 119 Request 119 Approval 120 Subscription 120 Instance 121 List
API Reference Contents Utilization API 137 Values for the detail parameter 139 Values for the scope parameter 139 We appreciate your feedback! 140 HP CSA 4.x API Reference Introduction The APIs for HP Cloud Service Automation use a REST interface. See http://en.wikipedia.org/wiki/Representational_state_transfer for general REST information. This documentation assumes that you know how to use REST interfaces. Caution: This document includes information only on the REST APIs provided in CSA 3.x.
API Reference Contents Artifact URI Method Parameters Description /artifact POST userIdentifier "Create an artifact" on page 12 /artifact/ GET userIdentifier, scope, detail, view "View an artifact" on page 12 /artifact/ PUT userIdentifier, scope, view "Update an artifact" on page 15 /artifact/ DELETE userIdentifier "Delete an artifact" on page 17 /artifact/fastview/ userIdentifier, view "Retrieve a predefined view for an artifact"
API Reference Contents Service Offering URI Method Parameters Description /artifact//document POST /artifact//document DELETE userIdentifier "Delete document from service offering" on page 30 /artifact//document/ POST userIdentifier "Update document in service offering" on page 31 /artifact//publish POST userIdentifier "Publish service offerings to catalog" on page 31 /artifact//unpublish
API Reference Contents Artifact type GET POST PUT Resource environment X Resource offering DELETE X X X Resource pool X X X X Resource provider X X X X Resource subscription X Service component X X X X Service blueprint X X X X Service instance X Service offering X Service request X Subscription X X X X X X Create an artifact Details URI /artifact Method POST Parameters userIdentifier= Required; the user ID you want to use as credentials for this AP
API Reference Contents URI /artifact/ Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call. See "Get userIdentifier" on page 88 for the steps required to get the userIdentifier value. scope=[base|baseplusone|subtree|view] Optional; default is base. If value is base, then the object is returned. If value is baseplusone, then the object and its first level children are returned.
API Reference Contents 90d96588360da0c701360da0f1d5f483 90d96588360da0c701360da0f1d5f483 true admin admin false false TestEnv TestEnv_November 17, 2012 1:24:55 AM UTC TestEnv 90d96588360da0c701360da0ef4700
API Reference Contents Artifact Type false false 0 0 0 Update an artifact Details URI /artifact/ Method PUT Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call.
API Reference Contents l Use the merge option as described under Parameters. Note: You can use the merge option with the view parameter to update only the view properties for which you specify values in the request body. Note: Collection specific behavior When a merge option is specified on a collection, for example _property_values_action_ =merge, all collection items specified in the PUT request body are updated. Any other collection items are left untouched.
API Reference Contents 90d96588360da0c701360da0f1d5f483 ... false TestProvider TestProvider_November 17, 2012 1:38:46 AM UTC TestProviderModified 90d96588360da0c701360da0ef470038 ... 90d96588360da0c701360da0eed8001f ...
API Reference Contents Deletion is subject to a set of business rules which depend on the type of artifact. The business rules for artifacts are explained in the table below. Note that consumption artifacts are not removed from the database when they are deleted; instead, the artifact is marked as retired. Please refer to the "Catalog API" on page 42 for retiring consumption artifacts.
API Reference Contents accessPoint.uri http://amz:443 accessPoint.password amz accessPoint.username amz accessPoint.category.name URL Filtering You can filter the results by providing a value for a property in the URI.
API Reference Contents property.valueType.name BOOLEAN property.name propBLN Retrieve resolved properties for an artifact A property can have a source binding configured that indicates its value is to be retrieved from a property on another artifact. The REST API discussed here provides a mechanism to retrieve the value from the source property.
API Reference Contents ... ... 90d9651a3684c7f0013684cafda80005 2012-04-05T16:15:57.480-07:00 2012-04-05T16:15:57.
API Reference Contents The following URL was used to retrieve a single property: https://:/csa/rest/artifact//resolveProperties? userIdentifier=&propertyName=PARENT_SVC_COMPONENT_ID The following XML was returned in the response: 90d9651a3684c7f0013684cafda80005 PARENT_SVC_COMPONENT_ID ...
API Reference Contents false sc_February 22, 2013 5:54:43 PM UTC ServiceConsumer1 ... ... false cn=ServiceConsumer,ou=ConsumerGroup,ou=CSAGroups ...
API Reference Contents https://:/csa/rest/artifact/8a81818f3d1421e7013d1423635a0003/group?u serIdentifier=90d96588360da0c701360da0f1d5f483 The following XML was sent: My-Group-Name cn=TestConsumer,ou=ConsumerGroup,ou=CSAGroups SERVICE_CONSUMER Another-Group-Name cn=TestConsumer2,ou=ConsumerGroup,ou=CSAGroups
API Reference Contents cn=TestConsumer2,ou=ConsumerGroup,ou=CSAGroups false SERVICE_CONSUMER false Update group display name, distinguished name Use this /artifact URI to update the group display name and/or distinguised name for the specified organization.
API Reference Contents
API Reference Contents https://:/csa/rest/artifact/8a81818f3d1421e7013d1423635a0003/group/8 a81818f3d1437e2013d1795d41107ea?userIdentifier=90d96588360da0c701360da0f1d5f483 The following XML was returned: Removed role association for My-New-Group-Name List resource providers Details URI /artifact Method GET Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call.
API Reference Contents ... Add document to service offering Details URI /artifact//document Method POST Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call. See "Get userIdentifier" on page 88 for the steps required to get the userIdentifier value.
API Reference Contents from base64 import b64encode import mimetypes import sys def get_content_type(filename): return mimetypes.guess_type(filename)[0] or 'application/octet-stream' def get_file_contents(filename): CRLF = '\r\n' f = open(filename, 'r') return CRLF.join(f.readlines()) def encode_multipart_formdata(filename): BOUNDARY = '----------CSA_r0ck$_$' CRLF = '\r\n' L = [] L.append('--' + BOUNDARY) L.append('Content-Disposition: form-data; name="file"; filename="%s"' % file name) L.
API Reference Contents Delete document from service offering Details URI /artifact//document/ Method DELETE Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call. See "Get userIdentifier" on page 88 for the steps required to get the userIdentifier value.
API Reference Contents Update document in service offering Details URI /artifact//document/ Method POST Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call. See "Get userIdentifier" on page 88 for the steps required to get the userIdentifier value.
API Reference Contents Example The following URL was sent: https://:/csa/rest/artifact/90e72e323b5330cc013b5358c0940021/publish ?userIdentifier=90d96588360da0c701360da0f1d5f483 The following XML was sent in the request:
API Reference Contents SERVICE_OFFERING ARTIFACT_TYPE AABBCCDD AABBCCDD CATALOG_CATEGORY The following XML was returned in the response:
API Reference Contents https://:/csa/rest/artifact/90e72e323b5330cc013b5358c0940021/unpubli sh?userIdentifier=90d96588360da0c701360da0f1d5f483 The following XML was sent in the request: OFFERING1_January 30, 2013 6:18:47 PM UTC SERVICE_OFFERING ARTIFACT_TYPE CRM CATALOG_CATE
API Reference Contents Retrieve artifact state and status Details URI /artifact/state/ Method GET Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call. See "Get userIdentifier" on page 88 for the steps required to get the userIdentifier value.
API Reference Contents l State will be returned and will contain one of the following values: n APPROVED n CANCELLED n COMPLETED n IN_PROGRESS n PENDING_APPROVAL n REJECTED n SUBMITTED l Status will be returned. If no value was set a null value will be returned.
API Reference Contents l l l With GET requests, views retrieve only the relevant data for the artifact and avoid loading all the data for the artifact. This leads to better performance. With PUT requests, the burden is not on the user to know all the artifact details to update the artifact. The user can pass only the necessary information. An example of using views is presented in "Update an artifact" on page 15 (using componentfinalize view).
API Reference Contents View name Properties Descriptio n artifactinfo state.name artifactType.name disabled ownedBy.name Retrieves the required properties from an artifact object in addition to all the basicinfo properties. basicinfo id name displayName description iconUrl detailedDescription isCriticalSystemObject Retrieves information from any Identity object. All artifacts and some additional entities (e.g., accessPoint) are identity objects. candidatepools resourceBinding.candidateProvider.
API Reference Contents View name Properties Descriptio n componentchil d componentChild.name componentChild.displayName componentChild.description componentChild.iconUrl componentChild.detailedDescription componentChild.isCriticalSystemObject componentChild.ownedBy.name componentChild.state.name componentChild.artifactType.name componentChild.disabled componentChild.serviceInstance.id componentChild.componentType.name componentChild.lifecycleProperties.lifecycleState.name componentChild.
API Reference Contents View name Properties Descriptio n disabledesign ServiceBlueprint.disabled Use this view to enable or disable a ServiceBluep rint. propertyinfo property.name property.values.value property.valueType.name property.consumerVisible property.displayName Retrieves a list of all the properties. U sed for creating new properties. propertyvalue property.name property.values.value property.consumerVisible property.
API Reference Contents View name Properties Descriptio n resourceBinding.id resourceBinding.validProvider.resourceBinding.id resourceBinding.validProvider.resourceProvider.id resourceBinding.validProvider.validPool.id validprovidersp ools Use this view to update valid resource providers and valid resource provider pools for a given resource binding. Availablevalues API Description Use this API to retrieve the list of available values for a dynamic property.
API Reference Contents URI /availablevalues/ property_id is an option model property, and is part of service design, offering and subscription artifacts. Returns 200 - Ok 400 - Not authorized 404 - Not found 500 - Server exception Example use context From the subscriber portal a property is selected from a drop down list. The values of any associated dynamic properties must be spontaneously populated - they are dynamic and therefore cannot be populated in advance.
API Reference Contents Base URL https://:/csa/rest URIs The following URIs are appended to the base URL: Catalog A catalog is the collection of services available to a consumer. URI Method Parameters Description /catalog GET userIdentifier, scope, detail "List catalogs" on page 46 /catalog/ GET userIdentifier, scope, detail "Get catalog details" on page 48 Category Categories allow you to classify service offerings in a service catalog.
API Reference Contents Request A request is created whenever a user initiates, changes, or deletes a subscription.
API Reference Contents Approval policy URI Method Parameters Description /catalog//policy//setCatalogApprovalPolicy POST userIdentifier "Update catalog approval policies" on page 67 /catalog//policy//setSOApprovalPolicy POST userIdentifier "Update service offerings approval policy" on page 68 Subscription A subscription is created when a consumer requests a service offering and includes all of the options selected by the consumer when the subscripti
API Reference Contents List catalogs Details URI /catalog Method GET Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call. This user should be a consumer user who has the necessary permissions for the data you want to work with. See "Get userIdentifier" on page 88 for the steps required to get the userIdentifier value. scope=[base|baseplusone|subtree] Optional; default is base. If value is base, then the object is returned.
API Reference Contents 90d96588364da0c701370da0ss320037 90d96588364da0c701370da0ss320037 2012-04-19T09:22:25.943-06:00 true Active /csa/images/categories/artifact_state/active.
API Reference Contents Get catalog details Details URI /catalog/ Use "List catalogs" on page 46 to get the catalog ID. Method GET Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call. This user should be a consumer user who has the necessary permissions for the data you want to work with. See "Get userIdentifier" on page 88 for the steps required to get the userIdentifier value. scope=[base|baseplusone|subtree] Optional; default is base.
API Reference Contents ACTIVE Active false 90d67588360da0c701360ss0ef420037 90d67588360da0c701360ss0ef420037 true ARTIFACT_STATE Artifact State false 90d96586760da0c701360da0ssd2001d 90d96586760da0c701360da0ssd2001d
API Reference Contents l l l Any category specified in the request body that already exists will be left unchanged. displayName is required. iconUrl and description are optional, and will be set to null if not specified.
API Reference Contents false description for catalog category /catalog/category/x.png EXAMPLE_FIRST_CATALOG_CATEGORY Example first Catalog Category false ... ...
API Reference Contents 8a81818f3d02fb7e013d0308894a0004 false Default catalog for the organization. /csa/images/library/briefcase-consumer_default_img-60.png Catalog_QA_ORG QA Org Catalog ... ... ...
API Reference Contents https://:/csa/rest/catalog/8a81818f3d02fb7e013d0308894a0004/ category/8a81818f3d128500013d1341a5c6000d ?userIdentifier=90d96588360da0c701360da0f1d5f483 The XML return content is basic catalog information as returned with the POST and PUT methods and most notably, will not include the category just deleted. List offerings in the catalog Details URI /catalog//offering Use "List catalogs" on page 46 to get the catalog ID.
API Reference Contents 90e763db3dd1a9a4013dd1e16aa16c95 90e763db3dd1a9a4013dd1e16aa16c95 2013-04-03T14:50:43.873-07:00 2013-04-03T14:50:43.
API Reference Contents URI /catalog//offering/ Use /catalog to get the catalog ID and /catalog//offering to get the offering ID. Returns 200 - Ok 401 - Not authorized 404 - Not found 500 - Server exception Examples Use the following URL: https://:/csa/rest/catalog/402895e33732af18013732b6f435006b/ offering/402895e337326d300137327ce1e30074 ?userIdentifier=90d9652b67ss6a930135f35b327e00a0 The following XML was returned in the response:
API Reference Contents URI /catalog//request Use "List catalogs" on page 46 to get the catalog ID. Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call. This user should be a consumer user who has the necessary permissions for the data you want to work with. See "Get userIdentifier" on page 88 for the steps required to get the userIdentifier value. scope=[base|view] Optional; default is base.
API Reference Contents true Active /csa/images/categories/artifact_state/active.
API Reference Contents description - request BE Request BE - Order server Request BE 8a8181853824bc1d013824c3ae350078 ORDER START_DATE 2012-06-26T10:58:58.233-08:00 END_DATE 2012-06-30T10:58:58.
API Reference Contents BOOLEAN true STR YY D6A80E16-2977-4111-14B9-0A5E5D5B2F56 18CA9979-7C9D-F5AC-06B5-0A5E5D5B3B51 The following XML was returned in the response: 8a818185382a26cc01382ab
API Reference Contents URI /catalog//request/ Use /catalog to get the catalog ID and /catalog//request to get the request ID. Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call. This user should be a consumer user who has the necessary permissions for the data you want to work with. See Get userIdentifier for the steps required to get the userIdentifier value.
API Reference Contents admin false false SD2 Offering desc - SD2 offering /csa/images/library/application.png request 1 request 1 8a8181853810699a01381079202c00d7 2012-06-21T12:16:09.900-07:00 2012-06-21T12:16:09.
API Reference Contents Cancel a request Details URI /catalog//request//cancel Use /catalog to get the catalog ID and /catalog//request to get the request ID. Method GET Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call. This user should be a consumer user who has the necessary permissions for the data you want to work with. See Get userIdentifier for the steps required to get the userIdentifier value.
API Reference Contents List approvals in the catalog Deprecation Notice The GET /catalog//approval URI has been deprecated. Use URI /user/myapproval instead as using the deprecated URI will not allow access to new functionality including the ability to list all approvals from all catalogs for a specified approver. Details URI /catalog//approval Use "List catalogs" on page 46 to get the catalog ID.
API Reference Contents Get approval details Details URI /catalog//approval/ Use /catalog to get the catalog ID and /catalog//approval to get the approval ID. Method GET Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call. This user should be a consumer user who has the necessary permissions for the data you want to work with. See Get userIdentifier for the steps required to get the userIdentifier value.
API Reference Contents URI /catalog//approval/ Use /catalog to get the catalog ID and /catalog//approval to get the approval ID. Body ApprovalProcess instance required in request body.
API Reference Contents URI /catalog//approval//approver Use /catalog to get the catalog ID and /catalog//approval to get the approval ID. Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call. This user should be a consumer user who has the necessary permissions for the data you want to work with. See Get userIdentifier for the steps required to get the userIdentifier value.
API Reference Contents CSA_CONSUMER REJECTED comment Update catalog approval policies Use this API to associate an approval policy with the specified catalog. Details URI /catalog//policy//setCatalogApprovalPolicy Use /catalog to get the catalog ID.
API Reference Contents 8a81818f3d4251ed013d46cc859002c1 ... 8a81818f3d4251ed013d46cc31ed02be EXAMPLE_APPROVAL_POLICY_March 7, 2013 9:40:19 PM UTC ... false 0 0 1 ... 8a81818f3d4251ed013d46c2b7f602bc ...
API Reference Contents Details URI /catalog//policy//setSOApprovalPolicy Use /catalog to get the catalog ID. Use /catalog//offering to get a catalog's service offering IDs, and /catalog//offering/ to get a service offering's policy ID. Method POST Parameters userIdentifier= 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.
API Reference Contents Updated approval policy of action of ORDER for service offering with id 8a81818f3d4251ed013d427c75e5005d Updated approval policy of action of MODIFY_SUBCRIPTION for service offering with id 8a81818f3d4251ed013d427c75e127c3 Failed to set approval policy for service offering with id 12345. Th e service offering is not found.
API Reference Contents The following XML was returned: 6 0 90d957ea3806fa7e013807acc79000b3 /csa/images/library/serviceOfferingDefault58.png MY SR MY SR ... SUBSCRIPTION ... false ...
API Reference Contents URI /catalog//subscription/ Use /catalog to get the catalog ID and /catalog//subscription to get the subscription ID. Returns 200 - Ok 401 - Not authorized 404 - Not found 500 - Server exception Examples The following URL was sent: https://:/csa/rest/catalog/402895e33732af18013732b6f435006b/ subscription/90d957ea3806fa7e013807acc79000b3 ?userIdentifier=90d9652b67ss6a930135f35b327e00a0 The following XML was returned:
API Reference Contents List instances in the catalog Deprecation Notice The GET /catalog//instance URI has been deprecated. Use URI /user/myinstance instead as using the deprecated URI will not allow viewing instances created by users who previously had access to the catalog, but no longer have access. Details URI /catalog//instance Use "List catalogs" on page 46 to get the catalog ID.
API Reference Contents MYSD ... ... ... Get instance details Details URI /catalog//instance/ Use /catalog to get the catalog ID and /catalog//instance to get the instance ID. Method GET Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call.
API Reference Contents URI /catalog//approval/ Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call. This user should be a consumer user who has the necessary permissions for the data you want to work with. See "Get userIdentifier" on page 88 for the steps required to get the userIdentifier value.
API Reference Contents Export API Description 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://:/csa/rest Details URI /export/ Method GET Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call.
API Reference Contents l Service offing archive contains: n Service offering XML n Service design XML n Resource offering XMLs n Icons used for customizing service offering, service design, and resource offerings n Dynamic option JSP files n Manifest XML l Catalog archive contains: n Catalog XML n Service offering XMLs n Service design XMLs n Resource offering XMLs n Resource environment XMLs n Icons used for customizing catalog, service offerings, service designs, and resource offerings n Dynamic optio
API Reference Contents Import API Description Use this API to import artifacts from a CSA content archive. CSA archives are created via the export REST API, the content archive tool, or the CSA management console. The import operation imports the primary artifact and all associated artifacts. Base URL https://:/csa/rest Details URI /import Method POST HP Cloud Service Automation (4.
API Reference Contents URI /import Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call. This user should be a consumer user who has the necessary permissions for the data you want to work with. See "Get userIdentifier" on page 88 for the steps required to get the userIdentifier value. file= Required; type 'Multipart/Form-Data' CSA archive zip to be imported.
API Reference Contents l l l Content-type: multipart/form-data Content-Disposition: form-data; name="file" Content-Type: application/octet-stream Example The following URL was sent to import the contents of the specified archive. https://:/csa/rest/import?userIdentifier=90d96588360da0c701360da0f1d 5f483&update=true&file=SERVICE_OFFERING_SO_ONE_ 90cec2ff3c81b896013c81b8c1780097.zip The following XML was returned:
API Reference Contents Details URI /importzip Method POST Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call. See "Get userIdentifier" on page 88 for the steps required to get the userIdentifier value. file= Required; multipart CSA archive zip to be imported. Note that the directory the file will be imported from is defined by the REST client or browser in use. Typically the file parameter will not include a directory path.
API Reference Contents Returns 200 - Updated 400 - Bad request 404 - Not found 500 - Server exception Caution: Component palette import is an update operation, and so associateProviders and updatePreserveExisting parameters will be ignored.
API Reference Contents Base URL https://:/csa/rest Details URI /import_result/ importResultRecord IDs are returned by the "Import API" on page 78 Method GET Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call. See "Get userIdentifier" on page 88 for the steps required to get the userIdentifier value.
API Reference Contents Error Import of Service offering archive successful. SUCCESS March 31, 2013 7:19:01 PM UTC admin
API Reference Contents URI /lifecycleengine/ Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call. See "Get userIdentifier" on page 88 for the steps required to get the userIdentifier value.
API Reference Contents 90d96588360da0c701360da0f21300ae 90d96588360da0c701360da0f21300ae true LIFECYCLE_STATE false Get latest lifecycle execution record for a service instance Details URI /lifecycleengine Method GET Parameters userIdentifier= Required; the user ID you want to use as credentials for this
API Reference Contents Examples Use the following URL: https://:/csa/rest/lifecycleengine/execute ?userIdentifier=90s96588670da0c701360da0f1d540a1 The following XML was sent in the request:
API Reference Contents Get userIdentifier Details URI /login// Where and are your credentials for logging in to HP Cloud Service Automation. If the user name you want to use includes a backslash or forward slash, see "Get userIdentifier for user name with slash" below.
API Reference Contents URI /login//userLookup Returns 200 - Ok 401 - Not authorized 404 - Not found 500 - Server exception Examples To get the userIdentifier, we used the following URL: https://:/csa/rest/login/MyOrganization/userLookup ?userName=admin/domain The following XML was returned in the response: 90s96588670da0c701360da0f1d540a1 ...
API Reference Contents View list of notification objects Details URI /notification/party/ Where the party ID is the UUID of a person, organization, or group. See How to find a party ID. Method GET Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call. This user should be a consumer user who has the necessary permissions for the data you want to work with.
API Reference Contents 1CSA Consumer ... ... Send notification Details URI /notification/party/ Method POST Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call. This user should be a consumer user who has the necessary permissions for the data you want to work with.
API Reference Contents 0 Token 0 content 1 Token 1 content Examples The following URL was sent: https://:/csa/rest/notification/party?userIdentifier=90cec3a03a93ef8 9013a93f07b880001 The following XML was sent in the request (note that the second recipient.id is bad):
API Reference Contents 2012-11-14T10:25:06.021-07:00 Test Subject 90cec39c3ae64d82013afff3e9c3002c 90d96588360da0c701360da0ef03002c PERSON acctgconsumer@econ-csa.
API Reference Contents URI Method Parameters Description /organization GET userIdentifier, scope, detail "View a list of organizations" below Note: The user identified by userIdentifier must have admin access.
API Reference Contents URI /organization/ Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call. See "Get userIdentifier" on page 88 for the steps required to get the userIdentifier value. Note: The user identified by userIdentifier must have admin access. scope=base Optional; the only valid value is base. detail=basic Optional; The only valid value is basic.
API Reference Contents 90d96588360da0c701360da0ef420037 90d96588360da0c701360da0ef420037 true ARTIFACT_STATE Artifact State false 90d96588360da0c701360da0eefc002a 90d96588360da0c701360da0eefc002a 2012-06-21T11:51:43.
API Reference Contents 90d96588360da0c701360da0f0020061 90d96588360da0c701360da0f0020061 2012-06-21T11:51:43.300-07:00 true Consumer /csa/images/categories/business_role/consumer.
API Reference Contents URI /organization/ "View a list of organizations" on page 94 to get the organization ID.
API Reference Contents true Organization /csa/images/categories/artifact_type/organization.
API Reference Contents BUSINESS_ROLE Business Role false List organization's approval policies Details URI /organization//approvalPolicy Method GET Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call. See "Get userIdentifier" on page 88 for the steps required to get the userIdentifier value.
API Reference Contents 0 0 90d96588360da0c701360da0f0b40094 90d96588360da0c701360da0f0b40094 2013-02-25T17:32:55.620-08:00 true User Context Template /csa/images/categories/approval_type/user_context_template.
API Reference Contents The types of approval policies supported are: NamedApproverApprovalTemplate, NamedGroupApprovalTemplate, UserContextApprovalTemplate, and DelegatedApprovalTemplate. In NamedApproverApprovalTemplate request body: l l l l displayName is required. approver is optional. minApprovalRequired is optional. If no approver is specified, defaults to 0. If any approver is specified, defaults to 1. Value cannot be greater than the number of approvers specified.
API Reference Contents REJECTED In UserContextApprovalTemplate request body: l l displayName is required. automaticApproval is optional; if not present, defaults to false.If automaticApproval is set to true: n automaticPeriodDuration (in days) is optional; if not present, defaults to 0. Valid value is integer from 0 to 365.
API Reference Contents https://:/csa/rest/organization/8a81818f3d1421e7013d1423635a0003/ approvalPolicy?userIdentifier=90d96588360da0c701360da0f1d5f483 The following XML was sent in the request: My-New-Approval-Template ProjectManager BudgetManager 2 true
API Reference Contents Named Approver Template ... ... 8a81818f3d1437e2013d17eec74408d8 ... BudgetManager ... 8a81818f3d1437e2013d177b13f107dd ... ProjectManager ...
API Reference Contents ProjectManager 0 false 0 REJECTED The following XML was returned:
API Reference Contents false Delete approval policy Details URI /organization//approvalPolicy/ Method DELETE Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call. See "Get userIdentifier" on page 88 for the steps required to get the userIdentifier value.
API Reference Contents /csa/images/categories/artifact_state/retired.png RETIRED Retired false ... ... Retrieve organization LDAP access point information Details URI /organization/accessPoint Method GET Parameters orgName= Required; the name of the organization for which the LDAP access point information is to be retrieved.
API Reference Contents List most requested, recently requested, or new offerings Details URI /organization/offering Organization is determiend by userIdentifier. Method GET Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call. See "Get userIdentifier" on page 88 for the steps required to get the userIdentifier value.
API Reference Contents Enterprise Red Hat Linux Server Enterprise Red Hat Linux Server 90e763db3ed8fe91013ed901a9ae047d 90e763db3ed8fe91013ed90156b100b4 false false 90d96588360da0c701360da0f4cc00ec false APPLICATION_SERVERS Application Servers
API Reference Contents Details URI /orgInformation/ Method GET Returns 200 - Ok 404 - Not found 500 - Server exception Example The following URL was sent: https://:/csa/rest/orgInformation/my_organization The following XML was returned in the response:
API Reference Contents URI Method Parameters Description /processinstances/ GET None "Retrieve a process instance" on the next page /processinstances POST userIdentifier "Create a process instance" on page 114 /processinstances/ PUT userIdentifier, scope, view, action "Update a process instance" on page 116 /processinstances//execute POST userIdentifie "Execute a process instance" on page 118 Process Instance structure XML
API Reference Contents Retrieve a process instance Details URI /processinstances/ Where is the process instance ID.
API Reference Contents Unit Test Process Instance Property Value 0 0 0 false false false 90d9652b35f41cbc0135f41cf1310004 Unit Test Process Definition 1 false INITIALIZED f
API Reference Contents l l l l Process definition ID. Context string. Includes contextual information that is relevant for the caller after the process instance has been created. Artifact ID. Properties. The properties provided here will be merged with the process definition properties. Two implicit tokens (reserved flow input variable names) are provided to process instances executed through the HP Operations Orchestration execution engine.
API Reference Contents Context for Unit Test Process Instance ID of the artifact executing the action 3600 false Update a process instance Details URI /processinstances/ Where is the process instance ID. Method PUT Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call.
API Reference Contents l l l l l l l INITIALIZED PENDING READY ACTIVE COMPLETED ERROR CANCELED Process instance return code (processReturnCode) values: l l l l SUCCESS FAILURE RUNNING TIMEOUT Examples The following was sent to update propertyinfo of a process instance: https://:/csa/rest/processinstances/90d9652b362d4ecd01362d4fb7be0f71 ?userIdentifier=90d9652b362d4ecd01362d4ef51e00a5&view=propertyinfo&scope=view&pr operty_action_=merge The following XML was sent in the request to update a
API Reference Contents https://:/csa/rest/processinstances/90d9652b3752ad4f013752ae38cb0065 ?userIdentifier=90d96588360da0c701360da0f1d5f483&scope=view&view=processinstance state&action=merge > 90d9652b3752ad4f013752ae38cb0065 SUCCESS The following was sent to update the process instance state, status and return code: https://:/csa/rest/processinstances/90d9652b3752ad4f013752ae38cb0065
API Reference Contents https://:/csa/rest/processinstances/90d9652b362d4ecd01362d4fb7be0f71 /execute/?userIdentifer=90d9652b35f35a930135f35b327e00a0 Search API Details URI /search Method GET Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call. This user should be a consumer user who has the necessary permissions for the data you want to work with.
API Reference Contents URI Method Parameters Description /user/instance//request GET userIdentifier "List service requests for subscription" on page 122 /user/myrequest GET userIdentifier, scope, detail, submitter, returnRetired, submitStartDate, submitEndDate "List active requests for user" on page 123 /user/request/count GET userIdentifier "Get count of requests for user" on page 125 /user/multipleRequest/cancel POST userIdentifier "Cancel multiple service requests" on page
API Reference Contents URI Method Parameters Description /user/mysubscription GET userIdentifier, scope, detail, requestor, returnRetired, creationStartDate, creationEndDate, modificationStartDate, modificationEndDate "List subscriptions for user" on page 131 /user/subscription/count GET userIdentifier "Get count of subscriptions for user" on page 133 /user/subscription GET userIdentifier, queryType "Get list of recent or expiring soon subscriptions for user" on page 134 userIdentifier "Del
API Reference Contents List service requests for subscription Details URI /user/instance//request Retuns the list of service requests for the specified subscription. A request's details will include information on any failed action instances. Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call. See "Get userIdentifier" on page 88 for the steps required to get the userIdentifier value.
API Reference Contents 2012-10-11T22:04:15.152-07:00 ... ... ... 90cec3a03a667c69013a9331365f3a54 requestPorcessorActionCallbackHandler false ... ... false ...
API Reference Contents URI /user/myrequest Parameters userIdentifier= Required; this user must be in the same organization as submitter, and must have the necessary permissions for the data you want to work with.See "Get userIdentifier" on page 88 for the steps required to get the userIdentifier value. scope=[base|view] Optional; default is base. detail=basic Optional; The only valid value is basic.
API Reference Contents 8a8181853810699a01381079190800a7 2012-06-21T12:16:08.073-07:00 2012-06-21T12:16:50.787-07:00 false SD2 Offering desc - SD2 offering /csa/images/library/application.
API Reference Contents URI /user/request/count Gets the number of requests for the user associated with userIdentifier. The results are grouped by request state. Returns 200 - Ok 401 - Not authorized 500 - Server exception Cancel multiple service requests Details URI /user/multipleRequest/cancel Method POST Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call.
API Reference Contents 90e72e283b05aff1013b0b2b43fc0356 90d965c0379fd06601379fd1936a0f05 The following XML was returned in the response. The count value indicates the number of service requests successfully canceled.
API Reference Contents Example Use the following URL: https://:/csa/rest/user/multipleRequest/delete ?userIdentifier=90d965c0379fd06601379fd192b30ee6 The following XML was sent in the request: 90e72e283b05aff1013b0b2c015103a4 90d965c0379fd06601379fd1936a0f05 90e72e283b05aff1013b0b2b43fc0356 90d965c0379fd06601379fd1936a0
API Reference Contents List approvals for approver Details URI /user/myapproval Method GET Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call. This user should be a consumer user who has the necessary permissions for the data you want to work with.See "Get userIdentifier" on page 88 for the steps required to get the userIdentifier value. scope=[base|view] Optional; default is base. detail=basic Optional; The only valid value is basic.
API Reference Contents Get count of approvals for user Details URI /user/approval/count Gets the number of approvals for the user associated with userIdentifier. The results are grouped by approval result state. Method GET Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call. This user should be a consumer user who has the necessary permissions for the data you want to work with.
API Reference Contents 90e72e713a94e0ab013aae76618e0e39 90d965c0379fd06601379fd1936a0f05 90e2a4133a75430b013a7a1328560377 90d965c0379fd06601379fd1936a0f05 The following XML was returned in the response.
API Reference Contents URI /user/mysubscription Parameters userIdentifier= Required; this user must be in the same organization as requestor, and must have the necessary permissions for the data you want to work with.See "Get userIdentifier" on page 88 for the steps required to get the userIdentifier value. scope=[base|view] Optional; default is base. detail=basic Optional; The only valid value is basic.
API Reference Contents https://:/csa/rest/mysubscription?userIdentifier=90d9652b67ss6a93013 5f35b327e00a0 &requestor=RnDUser The following XML was returned: 6 0 90d957ea3806fa7e013807acc79000b3 /csa/images/library/serviceOfferingDefault58.png MY SR MY SR ...
API Reference Contents Get list of recent or expiring soon subscriptions for user Details URI /user/subscription Returns a list of subscriptions for the user associated with userIdentifier. Method GET Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call. This user should be a consumer user who has the necessary permissions for the data you want to work with. See "Get userIdentifier" on page 88 for the steps required to get the userIdentifier value.
API Reference Contents https://:/csa/rest/user/multipleSubscription/delete ?userIdentifier=90d965c0379fd06601379fd192b30ee6 Â The following XML was sent in the request: 90e72e283b05aff1013b0b2c015103a4 90cef5de3c63429f013c6489245b09a2 90d965c0379fd06601379fd1936a0f05 90e72e283b05aff1013b0b2b43fc0356 9
API Reference Contents List instances for user Details URI /user/myinstance Method GET Parameters userIdentifier= Required; this user must be in the same organization as requestor, and must have the necessary permissions for the data you want to work with. See "Get userIdentifier" on page 88 for the steps required to get the userIdentifier value. scope=base Optional; the only valid value is base. detail=basic Optional; The only valid value is basic.
API Reference Contents 6 0 90d957ea3806fa7e01380f957d11070a MYSD_June 5, 2012 5:19:51 PM UTC MYSD ... ... ... Utilization API Description Use this API to retrieve a list of resource utilization objects for the specified subscription.
API Reference Contents Example The following URL was sent: https://:/csa/rest/utilization/90cec3a03a667c69013a6d7f0eea2cb3 The following XML was returned in the response:
API Reference Contents … … … Values for the detail parameter The detail parameter has the following values: l l l l l 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.
We appreciate your feedback! If you have comments about this document, you can contact the documentation team by email. If an email client is configured on this system, click the link above and an email window opens with the following information in the subject line: Feedback on Cloud Service Automation, 4.00 API Reference Just add your feedback to the email and click send.
