HP CloudSystem Enterprise Guia do Utilizador

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

URI Method Parameters Description/artifact/<organization_id>/group/<grou_id>PUT userIdentifier "Update group display name,distinguish

View a list of organizationsDetailsURI/organization/Method GETParametersuserIdentifier=<user_id>Required; the user ID you want to use as credent

<objectId>90d96588360da0c701360da0ef470038</objectId><createdOn>2012-06-21T11:51:43.267-07:00</createdOn><isCriticalSystemO

<id>90d96588360da0c701360da0efe20059</id><objectId>90d96588360da0c701360da0efe20059</objectId><isCriticalSystemObject>tr

URI/organization/<organization_id>"View a list of organizations" on page 100 to get the organization ID.ParametersuserIdentifier=<u

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

<id>90d96588360da0c701360da0f0020061</id><objectId>90d96588360da0c701360da0f0020061</objectId><createdOn>2012-06-21T11:5

<id>8a81818f3d1421e7013d1423646e0008</id><objectId>8a81818f3d1421e7013d1423646e0008</objectId><createdOn>2013-02-25T17:3

Create approval policyDetailsURI/organization/<organization_id>/approvalPolicyMethod POSTParametersuserIdentifier=<user_id>Required; the u

l displayName is required.l group's distinguishedName is required.l minApprovalRequired is optional and defaults 1. Value cannot be greater than

n automaticPeriodDuration (in days) is optional; if not present, defaults to 0. Valid value isinteger from 0 to 365.n automaticApprovalDecision is req

Artifact type GET POST PUT DELETEApproval template XApprover XCatalog X X X XDocument X X XGroup XNamed approver approval template XOrganization X X X

My-New-Approval-Template_February 26, 2013 7:19:47 PM UTC</name><displayName>My-New-Approval-Template</displayName><state> ...

URI/organization/<organization_id>/approvalPolicy/<policy_id>ParametersuserIdentifier=<user_id>Required; the user ID you want to use

<approvalType><id>90d96588360da0c701360da0f0b00093</id>...<name>NAMED_APPROVER_TEMPLATE</name>...</approvalType>&l

ExampleThe following URL was sent:https://<host>:<port>/csa/rest/organization/8a81818f3d1421e7013d1423635a0003/approvalPolicy/8a81818f3d14

URI/organization/accessPointReturns 200 - Ok401 - Not authorized500 - Server exceptionExampleThe following URL was sent:https://<host>:<port

ExampleThe following URL was sent:https://<host>:<port>/csa/rest/organization/offering?userIdentifier=90e763db3ed8fe91013ed90155e600b0&

<id>90d96588360da0c701360da0eecb001b</id><isCriticalSystemObject>false</isCriticalSystemObject><disabled>false</disab

Chapter 12: orgInformation APIDescriptionUse this API to get an organization's credentials.Base URLhttps://<host>:<port>/csa/restDeta

Chapter 13: Processinstances APIDescriptionThe Processinstance API is used to return execution results from HP Operations Orchestrationflows. When HP

</paramRoleType><scope><isCriticalSystemObject></isCriticalSystemObject><name></name> </scope><valueType&

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

The following was sent to retrieve a process instance:https://<host>:<port>/csa/rest/processinstances/90d9652b3752ad4f013752ae38cb0065The

Create a process instanceDetailsURI/processinstancesMethod POSTParametersuserIdentifier=<user_id>Required; the user ID you want to use as creden

</paramRoleType><valueType><isCriticalSystemObject>false</isCriticalSystemObject><name>STRING</name><disabled&g

URI/processinstances/<process_instance_id>Where <process_instance_id> is the process instance ID.ParametersuserIdentifier=<user_id>R

ExamplesThe following was sent to update propertyinfo of a process instance:https://<host>:<port>/csa/rest/processinstances/90d9652b362d4e

?userIdentifier=90d96588360da0c701360da0f1d5f483&scope=view&view=processinstancestate&action=merge<ProcessInstance>><id90d9652

Chapter 14: Search APIDetailsURI/searchMethod GETParametersuserIdentifier=<user_id>Required; the user ID you want to use as credentials for this

Chapter 15: User APIDescriptionUse this API to get information related to CSA users.Base URLhttps://<host>:<port>/csa/restURIsThe followin

URI Method Parameters Description/user/approval/count GET userIdentifier "Get count ofapprovals foruser" on page137/user/multipleApprovals/d

InstanceAn instance is created when a request is approved and includes details about the requestedservices such as the status of services, IP addresse

ExamplesUse the following URL:https://<host>:<port>/csa/rest/artifact/90e72e4f3b00a69e013b0bf7ed55002e?userIdentifier=<user_id>The f

<isCriticalSystemObject>false</isCriticalSystemObject><description>OctoberSampleService</description><iconUrl>/csa/image

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.Returns 200 - O

</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/myapprovalMethod GETParametersuserIdentifier=<user_id>Required; the user ID you want to use as creden

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

<displayName>Artifact State</displayName><extensible>false</extensible></categoryType></state><artifactType>

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/myinstanceMethod GETParametersuserIdentifier=<user_id>Required; this user must be in the same organizatio

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

Chapter 16: Utilization APIDescriptionUse this API to retrieve a list of resource utilization objects for the specified subscription.Base URLhttps://&

<isCriticalSystemObject>false</isCriticalSystemObject><name>Pool_1_March 22, 2013 6:46:31 PM UTC</name><displayName>Pool

Chapter 17: Values for the detail parameterThe detail parameter has the following values:l Required: Retrieves all the non-null and non-optional field

Chapter 18: Values for the scope parameterThe scope parameter has the following values:l Base: Retrieves the root entity of the artifact including all

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

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

This example shows how to change the finalize flag of a component using the view parameter.The following URL was sent:https://<host>:<port>

...</accessPoint><providerType><id>90d96588360da0c701360da0eeac0016</id>...</providerType><numberOfResourceOffering&g

DetailsURI/artifact/fastview/<artifact_id>Method GETParametersuserIdentifier=<user_id>Required; the user ID you want to use as credentials

FilteringYou can filter the results by providing a value for a property in the URI. The query is then filteredbased on that property. You can use the

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

There are two approaches to retrieving resolved properties:l Retrieve all propertiesl Retrieve a single named propertyDetailsURI/artifact/<artifact

<createdOn>2012-04-05T16:16:08.450-07:00</createdOn><updatedOn>2012-04-05T16:16:08.450-07:00</updatedOn><propertyBindingTyp

List active groups associated with an organizationDetailsURI/artifact/<organization_id>/groupMethod GETParametersuserIdentifier=<user_id>R

Add groups to an organizationDetailsURI/artifact/<organization_id>/groupMethod POSTParametersuserIdentifier=<user_id>Required; the user ID

<group><displayName>Another-Group-Name</displayName><distinguishedName>cn=TestConsumer2,ou=ConsumerGroup,ou=CSAGroups</dist

Update group display name, distinguished nameUse this/artifact URIto update the group display name and/or distinguised name for the specifiedorganiz

<disabled>false</disabled></state><artifactType><id>90d96588360da0c701360da0eeff002b</id><isCriticalSystemObjec

List resource providersDetailsURI/artifactMethod GETParametersuserIdentifier=<user_id>Required; the user ID you want to use as credentials for t

Add document to service offeringDetailsURI/artifact/<service_offering_id>/documentMethod POSTParametersuserIdentifier=<user_id>Required; t

import sysdef get_content_type(filename):return mimetypes.guess_type(filename)[0] or 'application/octet-stream'def get_file_contents(filenam

ContentsContents 3HP CSA 4.x API Reference Introduction 8Chapter 1: Artifact API 9URIs 9Artifact 9Group 9ResourceProvider 10Service Offering 10Artifa

Delete document from service offeringDetailsURI/artifact/<service_offering_id>/document/<document_id>Method DELETEParametersuserIdentifier

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

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>Method GETParametersuserIdentifier=<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 Properties Descriptionartifactinfo state.nameartifactType.namedisabledownedBy.nameRetrieves therequiredpropertiesfrom anartifact objectin ad

View name Properties Descriptioncomponentchild componentChild.namecomponentChild.displayNamecomponentChild.descriptioncomponentChild.iconUrlcomponentC

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

View name Properties Descriptiondisabledesign ServiceBlueprint.disabled Use this viewto enable ordisable aServiceBlueprint.propertyinfo property.namep

View name Properties Descriptionvalidproviderspools*resourceBinding.idresourceBinding.validProvider.resourceBinding.idresourceBinding.validProvider.re

Chapter 2: Availablevalues APIDescriptionUse this API to retrieve the list of available values for a dynamic property.Base URLhttps://<host>:<

first=parent1ValueThe following response was returned:<Property><id>90e763a43ddc18e5013ddc2f134c0088</id><name>child1</name

Chapter 3: Catalog APIDescriptionUse this API to get information related to CSA catalogs.Base URLhttps://<host>:<port>/csa/restURIsThe fol

URI Method Parameters Description/catalog/<catalog_id>/offeringGET userIdentifier, scope,detail, hasApproval"List offerings in thecatalog&q

URI Method Parameters Description/catalog/<catalog_id>/approval/<approval_id>/approverPUT userIdentifier "Update approval decisionusi

URI Method Parameters Descriptioncatalog/<catalog_id>/instance GET userIdentifier, scope,detail, requestor"List instances in thecatalog&quo

<objectId>402895e566cb32ss0136cb831752000f</objectId><createdOn>2012-04-19T09:23:04.913-06:00</createdOn><updatedOn>2012

</catalog>...</CatalogList>Get catalog detailsDetailsURI/catalog/<catalog_id>Use "List catalogs" on page 47 to get the cat

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

<id>90d96567360da0c701360ss0ef470038</id><objectId>90d96567360da0c701360ss0ef470038</objectId><isCriticalSystemObject>tr

URI/catalog/<catalog_id>/categoryReturns 200 - Ok401 - Not authorized404 - Object not found500 - Server exceptionIn the request body:l Any categ

<name>EXAMPLE_SECOND_CATEGORY</name><displayName>Example second category</displayName><disabled>false</disabled>&l

<CatalogCategory><displayName>Changing first example category name</displayName><iconUrl>/catalog/category/x.png</iconUrl&g

ExampleThe following URL was sent:https://<host>:<port>/csa/rest/catalog/8a81818f3d02fb7e013d0308894a0004/category/8a81818f3d128500013d134

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

URI/catalog/<catalog_id>/offering/<offering_id>Use "Catalog API" on page 44 to get the catalog ID and "List offerings in th

DetailsURI/catalog/<catalog_id>/requestUse "List catalogs" on page 47 to get the catalog ID.Method GETParametersuserIdentifier=<use

<displayName>request 1</displayName><state><id>90d96588360da0c701360da0ef470038</id><objectId>90d96588360da0c70136

https://<host>:<port>/csa/rest/catalog/90540a9734f502880134f502c82e0011/request?userIdentifier=90d9667ss5f46a930135f35b327e00a0The followi

Delete approval policy 112Retrieve organization LDAP access point information 113List most requested, recently requested, or new offerings 114Chapter

<value>33</value></values></property><property><name>BOOLEAN</name><values><value>true</value

URI/catalog/<catalog_id>/request/<request_id>Use "Catalog API" on page 44 to get the catalog ID and "List requests in theca

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

Cancel a requestDetailsURI/catalog/<catalog_id>/request/<request_id>/cancelUse "Catalog API" on page 44 to get the catalog ID an

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 API" on page 44 to get the catalog ID and

URI/catalog/<calalog_id>/approval/<approval_id>Use "Catalog API" on page 44 to get the catalog ID and "List approvals in th

URI/catalog/<calalog_id>/approval/<approval_id>/approverUse "Catalog API" on page 44 to get the catalog ID and "List approv

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

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

Chapter 16: Utilization API 145Chapter 17: Values for the detail parameter 147Chapter 18: Values for the scope parameter 148We appreciate your feedbac

DetailsURI/catalog/<calalog_id>/policy/<policy_id>/setSOApprovalPolicyUse "Catalog API" on page 44 to get the catalog ID. Use &q

<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>Us "Catalog API" on page 44 to get the catalog ID and "List subscrip

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

Chapter 4: Export APIDescriptionUse this API to export a supported artifact as a content archive.Supported artifacts includeresource environments, re

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

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

HP CSA 4.x API Reference IntroductionThe APIs for HP Cloud Service Automation (CSA) use a REST interface. Seehttp://en.wikipedia.org/wiki/Representati

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

l Content-Type: application/octet-streamExampleThe following URL was sent to import the contents of thespecified archive.https://<host>:<por

Chapter 6: Importzip APIDeprecation NoticeThe GET /importzip API has been deprecated. Use/import instead as using the deprecated API willnot include

ParametersuserIdentifier=<user_id>Required; the user ID you want to use as credentials for this API call. See "GetuserIdentifier" on p

updatePreserveExisting parameters will be ignored.The following headers must be set when using this API to upload the content archive:l Content-type:

Chapter 7: Import_result APIUse this API to view detailed result informationfrom importing a content archive. See "Import API"on page 79 f

<importOperation>Error</importOperation></importResultLogEntry><importResultLogEntry><artifactDescription>SD ONE</art

Chapter 8: Lifecycle engine APIDescriptionUse this API to work with lifecycle actions.Base URLBase URLhttps://<host>:<port>/csa/restURIsTh

https://<host>:<port>/csa/rest/lifecycleengine/90d96588360da0c701360da0f25400c2?userIdentifier=90s96588670da0c701360da0f1d540a1The followi

Get latest lifecycle execution record for a serviceinstanceDetailsURI/lifecycleengineMethod GETParametersuserIdentifier=<user_id>Required; the u

Chapter 1: Artifact APIDescriptionUse this API to view, create, and modify CSA artifacts.Base URLhttps://<host>:<port>/csa/restURIsThe fol

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><LifecycleExecutionRequest><reverse>false</r

Chapter 9: Login APIDescriptionUse this API to provide credentials for CSA REST APIs.Base URLhttps://<host>:<port>/csa/restURIsThe followi

when the user name includes non-alphanumeric characters. A best practice is to alwaysinclude a trailing slash.ExampleTo get the userIdentifier, we use

The value for userIdentifier is the first <id> value returned in the XML.APIReferenceHP Cloud Service Automation (4.10) Page 93 of 150

Chapter 10: Notification APIDescriptionUse this API to retrieve the notification objects associated with<party_id>, or to send a notificationto

URI/notification/party/<party_id>Where the party ID is the UUID of a person, organization, or group. See How tofind a party ID.Returns 200 - Ok4

URI/notification/party/<party_id>ParametersuserIdentifier=<user_id>Required; the user ID you want to use as credentials for this API call.

https://<host>:<port>/csa/rest/notification/party?userIdentifier=90cec3a03a93ef89013a93f07b880001The following XML was sent in the request

90cec3a03a93ef89013a93f07b880001</senderContextArtifactId><senderContextArtifactTypeId>90d96588360da0c701360da0ef03002c</senderContextA

Chapter 11: Organization APIDescriptionUse this API to view HP CSA organizations.Base URLhttps://<host>:<port>/csa/restURIsThe following U