CLI Reference Guide

ManualsBrandsHP ManualsSolutionsHP CloudSystem Enterprise

HPCloud Service Automation

For the Windows ® and Linux operating systems

Software Version: 4.10

APIReference

Document Release Date: July 2014

Software Release Date: July 2014

Summary of content (150 pages)

PAGE 1
HP Cloud Service Automation For the Windows ® and Linux operating systems Software Version: 4.
PAGE 2
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.
PAGE 3
Contents Contents 3 HP CSA 4.
PAGE 4
API Reference Contents URIs 44 Catalog 44 Category 44 Offering 44 Request 45 Approval 45 Approval policy 46 Subscription 46 Resource Subscription 46 Instance 46 List catalogs 47 Get catalog details 49 Create catalog categories 50 Update catalog categories 52 Delete catalog category 53 List offerings in the catalog 54 Get offering details 55 List requests in the catalog 56 Deprecation Notice 56 Submit a request 58 Get request details 60 Cancel a request 63 Retire
PAGE 5
API Reference Contents Deprecation Notice 71 Get subscription details 72 List instances in the catalog 74 Deprecation Notice 74 Get instance details 75 Retire an approval 75 Get resource subscription details 76 Chapter 4: Export API 77 Chapter 5: Import API 79 Chapter 6: Importzip API 82 Deprecation Notice 82 Chapter 7: Import_result API 85 Chapter 8: Lifecycle engine API 87 Get details for a lifecycle execution record 87 Get latest lifecycle execution record for a service insta
PAGE 6
API Reference Contents Delete approval policy 112 Retrieve organization LDAP access point information 113 List most requested, recently requested, or new offerings 114 Chapter 12: orgInformation API 117 Chapter 13: Processinstances API 118 URIs 118 Process Instance structure 118 Retrieve a process instance 119 Create a process instance 121 Update a process instance 122 Execute a process instance 125 Chapter 14: Search API 126 Chapter 15: User API 127 URIs 127 Request 127 Appro
PAGE 7
API Reference Contents Chapter 16: Utilization API 145 Chapter 17: Values for the detail parameter 147 Chapter 18: Values for the scope parameter 148 We appreciate your feedback! HP Cloud Service Automation (4.
PAGE 8
HP CSA 4.x API Reference Introduction The APIs for HP Cloud Service Automation (CSA) 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. See the HP Cloud Service Automation API Quick Start for information on communication with CSA using RESTful calls. Caution: This document includes information only on the REST APIs introduced in CSA 3.
PAGE 9
Chapter 1: Artifact API Description Use this API to view, create, and modify CSA artifacts.
PAGE 10
API Reference URI Method Parameters Description /artifact//group/ PUT userIdentifier "Update group display name, distinguished name" on page 25 /artifact//group/ DELETE userIdentifier "Delete or disassociate group from an organization" on page 26 Resource Provider URI Method Parameters Description /artifact GET userIdentifier, artifactType "List resource providers" on page 27 Service Offering URI Method Parameters Description /arti
PAGE 11
API Reference Artifact type GET POST PUT DELETE Approval template X Approver X Catalog X X X X Document X X Group X Named approver approval template X Organization X Person X Resource binding X Resource environment X Resource offering 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
PAGE 12
API Reference URI /artifact Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call. See "Get userIdentifier" on page 91 for the steps required to get the userIdentifier value. Returns 200 - Ok 401 - Not authorized 404 - Not found 500 - Server exception View an artifact Details URI /artifact/ Method GET Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call.
PAGE 13
API Reference Examples Use the following URL: https://:/csa/rest/artifact/90e72e4f3b00a69e013b0bf7ed55002e?userIde ntifier= The following XML was returned in the response: 90e72e4f3b00a69e013b0bf7ed55002e 90e72e4f3b00a69e013b0bf7ed55002e 2012-11-16T17:24:55.765-08:00 2012-11-16T17:24:55.
PAGE 14
API Reference Artifact State false 90d96588360da0c701360da0eedb0020 90d96588360da0c701360da0eedb0020 2012-11-01T15:16:57.787-07:00 true Resource Environment /csa/images/categories/artifact_type/resource_environment.
PAGE 15
API Reference URI /artifact/ Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call. See "Get userIdentifier" on page 91 for the steps required to get the userIdentifier value. view=&scope=view Optional; Used to update artifacts based on pre-defined views. See "Artifact views" on page 36 (description column) for a list of view types that support update operation.
PAGE 16
API Reference This example shows how to change the finalize flag of a component using the view parameter. The following URL was sent: https://:/csa/rest/artifact/90e72e4f3af5c989013afb471ebc0264?userIde ntifier=&scope=view&view=componentfinalize The following XML was sent in the request body: 90e72e4f3af5c989013afb471ebc0264 false This example shows changing the display name of a resource provider.
PAGE 17
API Reference ... 90d96588360da0c701360da0eeac0016 ... 0 0 0 Delete an artifact Details URI /artifact/ Method DELETE Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call.
PAGE 18
API Reference Details URI /artifact/fastview/ Method GET Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call. See "Get userIdentifier" on page 91 for the steps required to get the userIdentifier value. view= Required; see "Artifact views" on page 36 for a list of view types. Returns 200 - Ok 404 - Not found 500 - Server exception Examples The following URL was sent.
PAGE 19
API Reference Filtering You can filter the results by providing a value for a property in the URI. The query is then filtered based on that property. You can use the properties listed in "Artifact views" on page 36. Note: The property name that is specified in the URL must have the period (.) character replaced with the underscore (_) character. The following example shows the result when the previous example is filtered on a property name.
PAGE 20
API Reference There are two approaches to retrieving resolved properties: l l Retrieve all properties Retrieve a single named property Details URI /artifact//resolveProperties Method GET Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call. See "Get userIdentifier" on page 91 for the steps required to get the userIdentifier value. propertyName= Optional; the name of the property you want to retrieve.
PAGE 21
API Reference 2012-04-05T16:16:08.450-07:00 2012-04-05T16:16:08.450-07:00 SOURCE PROPERTY_BINDING_TYPE ... ... 90d9651a3684c7f0013684c91f8c0004 SVC_COMPONENT_ID ... ...
PAGE 22
API Reference List active groups associated with an organization Details URI /artifact//group Method GET Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call. See "Get userIdentifier" on page 91 for the steps required to get the userIdentifier value.
PAGE 23
API Reference Add groups to an organization Details URI /artifact//group Method POST Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call. See "Get userIdentifier" on page 91 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 role must be specified for each group in the request body. Valid roles are as follows.
PAGE 24
API Reference Another-Group-Name cn=TestConsumer2,ou=ConsumerGroup,ou=CSAGroups SERVICE_CONSUMER The following XML was returned:
PAGE 25
API Reference Update group display name, distinguished name Use this /artifact URI to update the group display name and/or distinguised name for the specified organization. Details URI /artifact//group/ Method PUT Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call. See "Get userIdentifier" on page 91 for the steps required to get the userIdentifier value.
PAGE 26
API Reference false 90d96588360da0c701360da0eeff002b false GROUP false false cn=TestConsumer,ou=ConsumerGroup,ou=CSAGroups Delete or disassociate group from an organization Use this URI to delete a group or to disassociate it from an organization.
PAGE 27
API Reference List resource providers Details URI /artifact Method GET Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call. See "Get userIdentifier" on page 91 for the steps required to get the userIdentifier value. artifactType=RESOURCE_PROVIDER Required; the only valid value is RESOURCE_PROVIDER. Basic view information is provided in the return content.
PAGE 28
API Reference 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 91 for the steps required to get the userIdentifier value.
PAGE 29
API Reference 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.append('Content-Type: %s' % get_content_type(filename)) L.append('') L.
PAGE 30
API Reference 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 91 for the steps required to get the userIdentifier value.
PAGE 31
API Reference 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 91 for the steps required to get the userIdentifier value.
PAGE 32
API Reference Example The following URL was sent: https://:/csa/rest/artifact/90e72e323b5330cc013b5358c0940021/publish ?userIdentifier=90d96588360da0c701360da0f1d5f483 The following XML was sent in the request:
PAGE 33
API Reference SERVICE_OFFERING ARTIFACT_TYPE AABBCCDD AABBCCDD CATALOG_CATEGORY The following XML was returned in the response:
PAGE 34
API Reference 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_CATEGORY
PAGE 35
API Reference 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 91 for the steps required to get the userIdentifier value.
PAGE 36
API Reference 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.
PAGE 37
API Reference 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 14 (using componentfinalize view).
PAGE 38
API Reference View name Properties Description 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.
PAGE 39
API Reference View name Properties componentchild 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.lifecycleProperties.lifecycleSubstate.
PAGE 40
API Reference View name Properties Description 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.displayName This view is useful if the need is only to update a property value.
PAGE 41
API Reference View name Properties Description validprovidersp ools* resourceBinding.id resourceBinding.validProvider.resourceBinding.id resourceBinding.validProvider.resourceProvider.id resourceBinding.validProvider.validPool.id Use this view to update valid resource providers and valid resource provider pools for a given resource binding.
PAGE 42
Chapter 2: Availablevalues API Description Use this API to retrieve the list of available values for a dynamic property. Base URL https://:/csa/rest Details URI /availablevalues/ property_id is an option model property, and is part of service design, offering and subscription artifacts. Method POST Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call.
PAGE 43
API Reference first=parent1Value The following response was returned: 90e763a43ddc18e5013ddc2f134c0088 child1 child1 true sample_jsp.jsp first=[CLIENT:parent1] value1 value1 displayName value1 description ...
PAGE 44
Chapter 3: Catalog API Description Use this API to get information related to CSA catalogs. 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.
PAGE 45
API Reference URI Method Parameters Description /catalog//offering GET userIdentifier, scope, detail, hasApproval "List offerings in the catalog" on page 54 /catalog//offering/ GET userIdentifier, scope, detail "Get offering details" on page 55 Request A request is created whenever a user initiates, changes, or deletes a subscription.
PAGE 46
API Reference URI Method Parameters Description /catalog//approval//approver PUT userIdentifier "Update approval decision using CSA approval process" on page 66 Approval policy URI Method Parameters Description /catalog//policy//setCatalogApprovalPolicy POST userIdentifier "Update catalog approval policies" on page 68 /catalog//policy//setSOApprovalPolicy POST userIdentifier "Update service offerings approval policy"
PAGE 47
API Reference URI Method Parameters Description catalog//instance GET userIdentifier, scope, detail, requestor "List instances in the catalog" on page 74 catalog//instance/ GET userIdentifier, scope, detail "Get instance details" on page 75 List catalogs Details URI /catalog Method GET Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call.
PAGE 48
API Reference 402895e566cb32ss0136cb831752000f 2012-04-19T09:23:04.913-06:00 2012-04-19T09:23:04.913-06:00 false Default catalog for the organization. consumer_catalog_a Consumer Catalog A 90d96588364da0c701370da0ss320037 90d96588364da0c701370da0ss320037 2012-04-19T09:22:25.
PAGE 49
API Reference ... Get catalog details Details URI /catalog/ Use "List catalogs" on page 47 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 91 for the steps required to get the userIdentifier value.
PAGE 50
API Reference 90d96567360da0c701360ss0ef470038 90d96567360da0c701360ss0ef470038 true ACTIVE Active false 90d67588360da0c701360ss0ef420037 90d67588360da0c701360ss0ef420037 true ARTIFACT_STATE Artifact State false
PAGE 51
API Reference URI /catalog//category Returns 200 - Ok 401 - Not authorized 404 - Object not found 500 - Server exception In the request body: 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.
PAGE 52
API Reference EXAMPLE_SECOND_CATEGORY Example second category false ... ... 8a81818f3d128500013d1341a5c6000d false description for catalog category /catalog/category/x.
PAGE 53
API Reference Changing first example category name /catalog/category/x.png New description for first example category The following XML was returned: 8a81818f3d02fb7e013d0308894a0004 false Default catalog for the organization.
PAGE 54
API Reference Example The following URL was sent: 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 47 to get the catalog ID.
PAGE 55
API Reference 3 0 90e763db3dd1a9a4013dd1e16aa16c95 90e763db3dd1a9a4013dd1e16aa16c95 2013-04-03T14:50:43.873-07:00 2013-04-03T14:50:43.
PAGE 56
API Reference URI /catalog//offering/ Use "Catalog API" on page 44 to get the catalog ID and "List offerings in the catalog" on the previous page to get the offering 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 91 for the steps required to get the userIdentifier value.
PAGE 57
API Reference Details URI /catalog//request Use "List catalogs" on page 47 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 91 for the steps required to get the userIdentifier value. scope=[base|view] Optional; default is base.
PAGE 58
API Reference request 1 90d96588360da0c701360da0ef470038 90d96588360da0c701360da0ef470038 2012-06-21T11:51:43.267-07:00 true Active /csa/images/categories/artifact_state/active.
PAGE 59
API Reference https://:/csa/rest/catalog/90540a9734f502880134f502c82e0011/request ?userIdentifier=90d9667ss5f46a930135f35b327e00a0 The following XML was sent in the request: description - request BE Request BE - Order server Request BE 8a8181853824bc1d013824c3ae350078 ORDER START_DATE 2012-06-26T
PAGE 60
API Reference 33 BOOLEAN true STR YY D6A80E16-2977-4111-14B9-0A5E5D5B2F56 18CA9979-7C9D-F5AC-06B5-0A5E5D5B3B51 The following XML was returned in the response:
PAGE 61
API Reference URI /catalog//request/ Use "Catalog API" on page 44 to get the catalog ID and "List requests in the catalog" on page 56 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" on page 91 for the steps required to get the userIdentifier value.
PAGE 62
API Reference 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.
PAGE 63
API Reference Cancel a request Details URI /catalog//request//cancel Use "Catalog API" on page 44 to get the catalog ID and "List requests in the catalog" on page 56 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.
PAGE 64
API Reference 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 47 to get the catalog ID.
PAGE 65
API Reference Get approval details Details URI /catalog//approval/ Use "Catalog API" on page 44 to get the catalog ID and "List requests in the catalog" on page 56 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.
PAGE 66
API Reference URI /catalog//approval/ Use "Catalog API" on page 44 to get the catalog ID and "List approvals in the catalog" on the previous page to get the approval ID. Body ApprovalProcess instance required in request body.
PAGE 67
API Reference URI /catalog//approval//approver Use "Catalog API" on page 44 to get the catalog ID and "List approvals in the catalog" on page 64 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" on page 91 for the steps required to get the userIdentifier value.
PAGE 68
API Reference 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 API" on page 44 to get the catalog ID.
PAGE 69
API Reference 8a81818f3d4251ed013d46cc859002c1 ... 8a81818f3d4251ed013d46cc31ed02be EXAMPLE_APPROVAL_POLICY_March 7, 2013 9:40:19 PM UTC ... false 0 0 1 ... 8a81818f3d4251ed013d46c2b7f602bc ...
PAGE 70
API Reference Details URI /catalog//policy//setSOApprovalPolicy Use "Catalog API" on page 44 to get the catalog ID. Use "List offerings in the catalog" on page 54 to get a catalog's service offering IDs, and "Get offering details" on page 55 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.
PAGE 71
API Reference 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.
PAGE 72
API Reference The following XML was returned: 6 0 90d957ea3806fa7e013807acc79000b3 /csa/images/library/serviceOfferingDefault58.png MY SR MY SR ... SUBSCRIPTION ... false ...
PAGE 73
API Reference URI /catalog//subscription/ Us "Catalog API" on page 44 to get the catalog ID and "List subscriptions in the catalog" on the previous page to get the subscription ID.
PAGE 74
API Reference 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 47 to get the catalog ID.
PAGE 75
API Reference MYSD ... ... ... Get instance details Details URI /catalog//instance/ Use "Catalog API" on page 44 to get the catalog ID and "List instances in the catalog" on the previous page to get the instance ID. Method GET Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call.
PAGE 76
API Reference 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 91 for the steps required to get the userIdentifier value.
PAGE 77
Chapter 4: 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. See "Get userIdentifier" on page 91 for the steps required to get the userIdentifier value.
PAGE 78
API Reference 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 option JSP fil
PAGE 79
Chapter 5: 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.
PAGE 80
API Reference 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 91 for the steps required to get the userIdentifier value. file= Required; type 'Multipart/Form-Data' CSA archive zip to be imported.
PAGE 81
API Reference l 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: Service offering SO ONE imported successfully.
PAGE 82
Chapter 6: Importzip API Deprecation Notice The GET /importzip API has been deprecated. Use /import instead as using the deprecated API will not include new functionality. Description Use this API to import an artifact from a CSA artifact 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.
PAGE 83
API Reference Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call. See "Get userIdentifier" on page 91 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. forceCreation=[true|false] Optional; default is false.
PAGE 84
API Reference updatePreserveExisting parameters will be ignored. The following headers must be set when using this API to upload the content archive: 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: https://localhost:8444/csa/rest/importzip ?userIdentifier=90d96588360da0c701360da0f1d5f483&file= SERVICE_DESIGN_Simple_Compute_Linux_90cec2023cc75f8a013cc7643ad00034.
PAGE 85
Chapter 7: Import_result API Use this API to view detailed result information from importing a content archive. See "Import API" on page 79 for details on importing a content archive. Base URL https://:/csa/rest Details URI /import_result/ importResultRecord IDs are returned by the "Import API" on page 79"Import API" on page 79 Method GET Parameters userIdentifier= Required; the user ID you want to use as credentials for this API call.
PAGE 86
API Reference Error SD ONE SD ONE SD_ONE_February 11, 2013 7:03:41 PM UTC SERVICE_BLUEPRINT Error Import of Service offering archive successful.
PAGE 87
Chapter 8: Lifecycle engine API Description Use this API to work with lifecycle actions.
PAGE 88
API Reference https://:/csa/rest/lifecycleengine/90d96588360da0c701360da0f25400c2 ?userIdentifier=90s96588670da0c701360da0f1d540a1 The following XML was returned in the response:
PAGE 89
API Reference 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 call. See "Get userIdentifier" on page 91 for the steps required to get the userIdentifier value. serviceInstanceId= Required; the ID of the service instance.
PAGE 90
API Reference false 90d96588372d758101372d75aebb009f 90d96588372d758101372d75aeb90087 DEPLOYED HP Cloud Service Automation (4.
PAGE 91
Chapter 9: Login API Description Use this API to provide credentials for CSA REST APIs. Base URL https://:/csa/rest URIs The following URIs are appended to the base URL: URI Method Parameters Description /login// GET none "Get userIdentifier" below /login//userLookup GET userName "Get userIdentifier for user name with slash" on the next page See "orgInformation API" on page 117 for getting an organzation's credentials.
PAGE 92
API Reference when the user name includes non-alphanumeric characters. A best practice is to always include a trailing slash. Example To get the userIdentifier, we used the following URL: https://:/csa/rest/login/MyOrganization/admin/ The following XML was returned in the response: 90s96588670da0c701360da0f1d540a1 ...