HP CloudSystem Matrix Guida Utente

HP Cloud Service AutomationFor the Windows ® and Linux operating systemsSoftware Version: 4.00APIReferenceDocument Release Date: January 2014Software

ArtifactURI Method Parameters Description/artifact POST userIdentifier "Create an artifact" on page 12/artifact/<artifact_id> GET user

<name>BUSINESS_ROLE</name><displayName>Business Role</displayName><extensible>false</extensible></categoryType&

<automaticPeriodDuration>0</automaticPeriodDuration><minApprovalRequired>0</minApprovalRequired><approvalType><id>

The types of approval policies supported are: NamedApproverApprovalTemplate,NamedGroupApprovalTemplate, UserContextApprovalTemplate, andDelegatedAppro

<automaticApprovalDecision><automaticApprovalDecision><name>REJECTED</name></automaticApprovalDecision></NamedGroupAp

https://<host>:<port>/csa/rest/organization/8a81818f3d1421e7013d1423635a0003/approvalPolicy?userIdentifier=90d96588360da0c701360da0f1d5f48

<description>Named Approver Template</description>...</approvalType><automaticApprovalDecision> ... </automaticApprovalDeci

<approver><userName>ProjectManager</userName></approver><minApprovalRequired>0</minApprovalRequired><automaticA

<disabled>false</disabled></organization></approver></NamedApproverApprovalTemplate>Delete approval policyDetailsURI/org

<iconUrl>/csa/images/categories/artifact_state/retired.png</iconUrl><name>RETIRED</name><displayName>Retired</display

List most requested, recently requested, or newofferingsDetailsURI/organization/offeringOrganization is determiend by userIdentifier.MethodGETParamete

Service OfferingURI Method Parameters Description/artifact/<service_offering_id>/documentPOST userIdentifier "Add document to serviceofferi

<name>Enterprise Red Hat Linux Server</name><displayName>Enterprise Red Hat Linux Server</displayName><catalogItem><i

DetailsURI/orgInformation/<organization name>MethodGETReturns200 - Ok404 - Not found500 - Server exceptionExampleThe following URL was sent:http

URI Method Parameters Description/processinstances/<process_instance_id>GET None "Retrieve a processinstance" on the next page/process

<id></id><name></name></processDefinition><processInstanceState><isCriticalSystemObject></isCriticalSyste

<value>Unit Test Process Instance Property Value</value></values><maxOccurs>0</maxOccurs><minOccurs>0</minOccur

l Process definition ID.l Context string. Includes contextual information that is relevant for the caller after the processinstance has been created.l

<context>Context for Unit Test Process Instance</context><artifactId>ID of the artifact executing the action</artifactId><t

l INITIALIZEDl PENDINGl READYl ACTIVEl COMPLETEDl ERRORl CANCELEDProcess instance return code (processReturnCode) values:l SUCCESSl FAILUREl RUNNINGl

https://<host>:<port>/csa/rest/processinstances/90d9652b3752ad4f013752ae38cb0065?userIdentifier=90d96588360da0c701360da0f1d5f483&scope

https://<host>:<port>/csa/rest/processinstances/90d9652b362d4ecd01362d4fb7be0f71/execute/?userIdentifer=90d9652b35f35a930135f35b327e00a0Se

Artifact type GET POST PUT DELETEResource environment XResource offering X X XResource pool X X X XResource provider X X X XResource subscription X XS

URI Method Parameters Description/user/instance/<instance_id>/requestGET userIdentifier "List servicerequests forsubscription" onpage

URI Method Parameters Description/user/mysubscription GET userIdentifier, scope, detail,requestor, returnRetired,creationStartDate,creationEndDate,mod

List service requests for subscriptionDetailsURI/user/instance/<instance_id>/requestRetuns the list of service requests for the specified subscr

<updatedOn>2012-10-11T22:04:15.152-07:00</createdOn><action> ... </action><processInstance> ... </processInstance>

URI/user/myrequestParametersuserIdentifier=<user_id>Required; this user must be in the same organization as submitter, and musthave the necessar

<objectId>8a8181853810699a01381079190800a7</objectId><createdOn>2012-06-21T12:16:08.073-07:00</createdOn><updatedOn>2012

URI/user/request/countGets the number of requests for the user associated with userIdentifier. Theresults are grouped by request state.Returns200 - Ok

</catalog></catalogItem></ServiceRequest><ServiceRequest><id>90e72e283b05aff1013b0b2b43fc0356</id><catalogItem&

ExampleUse the following URL:https://<host>:<port>/csa/rest/user/multipleRequest/delete?userIdentifier=90d965c0379fd06601379fd192b30ee6The

List approvals for approverDetailsURI/user/myapprovalMethodGETParametersuserIdentifier=<user_id>Required; the user ID you want to use as credent

URI/artifact/<artifact_id>ParametersuserIdentifier=<user_id>Required; the user ID you want to use as credentials for this API call. See &q

Get count of approvals for userDetailsURI/user/approval/countGets the number of approvals for the user associated with userIdentifier. Theresults are

<ApprovalProcessList><approvalProcess><id>90e72e713a94e0ab013aae76618e0e39</id><catalogItem><catalog><id>90d

URI/user/mysubscriptionParametersuserIdentifier=<user_id>Required; this user must be in the same organization as requestor, and musthave the nec

https://<host>:<port>/csa/rest/mysubscription?userIdentifier=90d9652b67ss6a930135f35b327e00a0 &requestor=RnDUserThe following XML was

Get list of recent or expiring soon subscriptions foruserDetailsURI/user/subscriptionReturns a list of subscriptions for the user associated with user

https://<host>:<port>/csa/rest/user/multipleSubscription/delete?userIdentifier=90d965c0379fd06601379fd192b30ee6 ÂThe following XML was se

List instances for userDetailsURI/user/myinstanceMethodGETParametersuserIdentifier=<user_id>Required; this user must be in the same organization

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><ServiceInstanceList><count>6</count><

ExampleThe following URL was sent:https://<host>:<port>/csa/rest/utilization/90cec3a03a667c69013a6d7f0eea2cb3The following XML was returne

<utilization> … </utilization><utilization> … </utilization>…</UtilizationList>Values for the detail parameterThe detail

</createdBy><updatedBy><id>90d96588360da0c701360da0f1d5f483</id><objectId>90d96588360da0c701360da0f1d5f483</objectId&

We appreciate your feedback!If you have comments about this document, you can contact the documentation team by email. Ifan email client is configured

<displayName>Artifact Type</displayName><extensible>false</extensible></categoryType></artifactType><disabled&g

l Use the merge option as described under Parameters.Note: You can use the merge option with the view parameter to update only the viewproperties for

<updatedBy><id>90d96588360da0c701360da0f1d5f483</id>...</updatedBy><isCriticalSystemObject>false</isCriticalSystemObj

Deletion is subject to a set of business rules which depend on the type of artifact. The businessrules for artifacts are explained in the table below.

<key>accessPoint.uri</key><value xsi:type="xs:string">http://amz:443</value></entry><entry><key>ac

Legal NoticesWarrantyThe only warranties for HP products and services are set forth in the express warranty statementsaccompanying such products and s

<entry><key>property.valueType.name</key><value xsi:type="xs:string">BOOLEAN</value></entry><entry>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><Properties><property> ... </property><

</Properties>The following URL was used to retrieve a single property:https://<host>:<port>/csa/rest/artifact/<id>/resolveProp

<isCriticalSystemObject>false</isCriticalSystemObject><name>sc_February 22, 2013 5:54:43 PM UTC</name><displayName>Servi

https://<host>:<port>/csa/rest/artifact/8a81818f3d1421e7013d1423635a0003/group?userIdentifier=90d96588360da0c701360da0f1d5f483The followin

<distinguishedName>cn=TestConsumer2,ou=ConsumerGroup,ou=CSAGroups</distinguishedName><role><isCriticalSystemObject>false</i

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><Group><id>8a81818f3d1437e2013d1795d41107ea<

https://<host>:<port>/csa/rest/artifact/8a81818f3d1421e7013d1423635a0003/group/8a81818f3d1437e2013d1795d41107ea?userIdentifier=90d96588360

...</ResourceProviderList>Add document to service offeringDetailsURI/artifact/<service_offering_id>/documentMethodPOSTParametersuserIdenti

from base64 import b64encodeimport mimetypesimport sysdef get_content_type(filename):return mimetypes.guess_type(filename)[0] or 'application/oct

Documentation UpdatesThe title page of this document contains the following identifying information:l Software Version number, which indicates the sof

Delete document from service offeringDetailsURI/artifact/<service_offering_id>/document/<document_id>MethodDELETEParametersuserIdentifier=

Update document in service offeringDetailsURI/artifact/<service_offering_id>/document/<document_id>MethodPOSTParametersuserIdentifier=<

ExampleThe following URL was sent:https://<host>:<port>/csa/rest/artifact/90e72e323b5330cc013b5358c0940021/publish?userIdentifier=90d96588

<artifactContextType><name>SERVICE_OFFERING</name><categoryType><name>ARTIFACT_TYPE</name></categoryType><

https://<host>:<port>/csa/rest/artifact/90e72e323b5330cc013b5358c0940021/unpublish?userIdentifier=90d96588360da0c701360da0f1d5f483The foll

Retrieve artifact state and statusDetailsURI/artifact/state/<artifact_id>MethodGETParametersuserIdentifier=<user_id>Required; the user ID

l State will be returned and will contain one of the following values:n APPROVEDn CANCELLEDn COMPLETEDn IN_PROGRESSn PENDING_APPROVALn REJECTEDn SUBMI

l With GET requests, views retrieve only the relevant data for the artifact and avoid loading all thedata for the artifact. This leads to better perfo

View name PropertiesDescriptionartifactinfo state.nameartifactType.namedisabledownedBy.nameRetrieves therequiredpropertiesfrom anartifact objectin add

View name PropertiesDescriptioncomponentchildcomponentChild.namecomponentChild.displayNamecomponentChild.descriptioncomponentChild.iconUrlcomponentChi

SupportVisit the HP Software Support Online web site at:http://www.hp.com/go/hpsoftwaresupportThis web site provides contact information and details a

View name PropertiesDescriptiondisabledesign ServiceBlueprint.disabled Use this viewto enable ordisable aServiceBlueprint.propertyinfo property.namepr

View name PropertiesDescriptionvalidproviderspoolsresourceBinding.idresourceBinding.validProvider.resourceBinding.idresourceBinding.validProvider.reso

URI/availablevalues/<property_id>property_id is an option model property, and is part of service design, offeringand subscription artifacts.Retu

Base URLhttps://<host>:<port>/csa/restURIsThe following URIs are appended to the base URL:CatalogA catalog is the collection of services a

RequestA request is created whenever a user initiates, changes, or deletes a subscription.URI Method Parameters Description/catalog/<catalog_id>

Approval policyURI Method Parameters Description/catalog/<catalog_id>/policy/<policy_id>/setCatalogApprovalPolicyPOST userIdentifier "

List catalogsDetailsURI/catalogMethodGETParametersuserIdentifier=<user_id>Required; the user ID you want to use as credentials for this API call

<state><id>90d96588364da0c701370da0ss320037</id><objectId>90d96588364da0c701370da0ss320037</objectId><createdOn>20

Get catalog detailsDetailsURI/catalog/<catalog_id>Use "List catalogs" on page 46 to get the catalog ID.MethodGETParametersuserIdentifi

<name>ACTIVE</name><displayName>Active</displayName><disabled>false</disabled><categoryType><id>90d675

ContentsContents 5HP CSA 4.x API Reference Introduction 9Artifact API 9URIs 9Artifact 10Group 10ResourceProvider 10Service Offering 11Artifact types

l Any category specified in the request body that already exists will be left unchanged.l displayName is required.l iconUrl and descriptionare option

<isCriticalSystemObject>false</isCriticalSystemObject><description>description for catalog category</description><iconUrl&g

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><Catalog><id>8a81818f3d02fb7e013d0308894a0004&l

https://<host>:<port>/csa/rest/catalog/8a81818f3d02fb7e013d0308894a0004/category/8a81818f3d128500013d1341a5c6000d?userIdentifier=90d965883

<id>90e763db3dd1a9a4013dd1e16aa16c95</id><objectId>90e763db3dd1a9a4013dd1e16aa16c95</objectId><createdOn>2013-04-03T14:5

URI/catalog/<catalog_id>/offering/<offering_id>Use /catalog to get the catalog ID and /catalog/<catalog_id>/offering to get theoffer

URI/catalog/<catalog_id>/requestUse "List catalogs" on page 46 to get the catalog ID.ParametersuserIdentifier=<user_id>Required;

<isCriticalSystemObject>true</isCriticalSystemObject><description>Active</description><iconUrl>/csa/images/categories/ar

<ServiceRequest><description>description - request BE </description><name>Request BE - Order server</name><displayNam

<name>BOOLEAN</name><values><value>true</value></values></property><property><name>STR</name&

URIs 43Catalog 43Category 43Offering 43Request 44Approval 44Approval policy 45Subscription 45Resource Subscription 45Instance 45List catalogs 46Get ca

URI/catalog/<catalog_id>/request/<request_id>Use /catalog to get the catalog ID and /catalog/<catalog_id>/request to get therequest

<displayName>admin</displayName><disabled>false</disabled></updatedBy><isCriticalSystemObject>false</isCritical

Cancel a requestDetailsURI/catalog/<catalog_id>/request/<request_id>/cancelUse /catalog to get the catalog ID and /catalog/<catalog_id&

List approvals in the catalogDeprecation NoticeThe GET/catalog/<catalog_id>/approval URI has been deprecated. Use URI /user/myapprovalinstead

Get approval detailsDetailsURI/catalog/<calalog_id>/approval/<approval_id>Use /catalog to get the catalog ID and /catalog/<catalog_id&g

URI/catalog/<calalog_id>/approval/<approval_id>Use /catalog to get the catalog ID and /catalog/<catalog_id>/approval to get theappro

URI/catalog/<calalog_id>/approval/<approval_id>/approverUse /catalog to get the catalog ID and /catalog/<id>/approval to get the app

<organization><name>CSA_CONSUMER</name></organization></person><approverResult><name>REJECTED</name>&l

<id>8a81818f3d4251ed013d46cc859002c1</id>...<approvalTemplate xsi:type="namedApproverApprovalTemplateVO"><id>8a81818

DetailsURI/catalog/<calalog_id>/policy/<policy_id>/setSOApprovalPolicyUse /catalog to get the catalog ID. Use /catalog/<catalog_id>/

Deprecation Notice 70Get subscription details 71List instances in the catalog 73Deprecation Notice 73Get instance details 74Retire an approval 74Get r

<messageList><messages>Updated approval policy of action of ORDER for service offering withid 8a81818f3d4251ed013d427c75e5005d </messag

The following XML was returned:<?xml version="1.0" encoding="UTF-8" standalone="yes"?><ServiceSubscriptionList&

URI/catalog/<catalog_id>/subscription/<subscription_id>Use /catalog to get the catalog ID and /catalog/<id>/subscription to get thes

List instances in the catalogDeprecation NoticeThe GET/catalog/<catalog_id>/instance URI has been deprecated. Use URI /user/myinstanceinstead

<displayName>MYSD</displayName><state></state><serviceInstanceState>...</serviceInstanceState>...</ServiceInsta

URI/catalog/<catalog_idid>/approval/<approval_id>ParametersuserIdentifier=<user_id>Required; the user ID you want to use as credenti

Export APIDescriptionUse this API to export a supported artifact as a content archive.Supported artifacts includeresource environments, resource offe

l Service offing archive contains:n Service offering XMLn Service design XMLn Resource offering XMLsn Icons used for customizing service offering, ser

Import APIDescriptionUse this API to import artifacts from a CSAcontent archive.CSA archives are created via theexport REST API, the content archive

URI/importParametersuserIdentifier=<user_id>Required; the user ID you want to use as credentials for this API call. This usershould be a consume

Delete approval policy 107Retrieve organization LDAP access point information 108List most requested, recently requested, or new offerings 109orgInfor

l Content-type: multipart/form-datal Content-Disposition: form-data; name="file"l Content-Type: application/octet-streamExampleThe following

DetailsURI/importzipMethodPOSTParametersuserIdentifier=<user_id>Required; the user ID you want to use as credentials for this API call. See &quo

Returns200 -Updated400 - Bad request404 - Not found500 - Server exceptionCaution: Component palette import isan update operation, and so associatePr

Base URLhttps://<host>:<port>/csa/restDetailsURI/import_result/<importResultRecord_id>importResultRecord IDs are returned by the &qu

<importOperation>Error</importOperation></importResultLogEntry><importSummary>Import of Service offering archive successful.&l

URI/lifecycleengine/<lifecycle_action_id>ParametersuserIdentifier=<user_id>Required; the user ID you want to use as credentials for this A

<categoryType><id>90d96588360da0c701360da0f21300ae</id><objectId>90d96588360da0c701360da0f21300ae</objectId><isCritic

ExamplesUse the following URL:https://<host>:<port>/csa/rest/lifecycleengine/execute?userIdentifier=90s96588670da0c701360da0f1d540a1The fo

Get userIdentifierDetailsURI/login/<organization_name>/<user_name>Where <organization_name> and <user_name> are your credentia

URI/login/<organization_name>/userLookupReturns200 - Ok401 - Not authorized404 - Not found500 - Server exceptionExamplesTo get the userIdentifie

Utilization API 137Values for the detail parameter 139Values for the scope parameter 139We appreciate your feedback! 140HP CSA 4.x API Reference Intro

View list of notification objectsDetailsURI/notification/party/<party_id>Where the party ID is the UUID of a person, organization, or group. See

<tokens><tokenSequence>1</tokenSequence><value>CSA Consumer</value></tokens>...</notification>...</Notifi

<tokenSequence>0</tokenSequence><value>Token 0 content</value></tokens><tokens><tokenSequence>1</tokenSeq

</notifContentBody><notifCreatedOn>2012-11-14T10:25:06.021-07:00</notifCreatedOn><notifSubject>Test Subject</notifSubject&g

URI Method Parameters Description/organization GET userIdentifier,scope, detail"View a list of organizations"belowNote: The user identified

URI/organization/ParametersuserIdentifier=<user_id>Required; the user ID you want to use as credentials for this API call. See "GetuserIden

<categoryType><id>90d96588360da0c701360da0ef420037</id><objectId>90d96588360da0c701360da0ef420037</objectId><isCritic

<businessRole><id>90d96588360da0c701360da0f0020061</id><objectId>90d96588360da0c701360da0f0020061</objectId><createdO

URI/organization/<organization_id>"View a list of organizations" on page 94 to get the organization ID.Returns200 - Ok401 - Not author

<isCriticalSystemObject>true</isCriticalSystemObject><description>Organization</description><iconUrl>/csa/images/categor