Home

HP CloudSystem Enterprise CLI Reference Guide

1. Example artifact lt service_offering id gt document lt document_id gt POST userIdentifier lt user_id gt Required the user ID you want to use as credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier value 200 Ok 401 Not authorized 404 Object not found 500 Server exception The following URL was sent with headers e Content type multipart form data e Content Disposition form data name file e Content Type application octet stream https lt host gt lt port gt csa rest artifact 90cecQ 123ae20db2013ae2111e3e9 e00a documen t 90ceco123afffe57013afffec64f0001 gt userIdentifier 90d96588360da0c701360da0f1d5f4 83 See Add document to service offering on page 28 for a more detailed example Publish service offerings to catalog Details URI Method Parameters Returns artifact lt catlog_id gt publish POST userIdentifier lt user_id gt Required the user ID you want to use as credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier value 200 Ok 401 Not authorized 404 Object not found 500 Server exception HP Cloud Service Automation 4 10 Page 31 of 150 API Reference Example The following URL was sent https lt host gt lt port gt csa rest artifact 90e72e323b5330cc013b5358c0940021 publish userIdentifier 90d96588360da0c701360da0f1d5f483 Th
2. Method Parameters user request count Gets the number of requests for the user associated with userldentifier The results are grouped by request state GET userIdentifier lt user_id gt 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 userldentifier on page 91 for the steps required to get the userldentifier value HP Cloud Service Automation 4 10 Page 132 of 150 API Reference URI Returns user request count Gets the number of requests for the user associated with userldentifier The results are grouped by request state 200 Ok 401 Not authorized 500 Server exception Cancel multiple service requests Details URI Method Parameters Returns user multipleRequest cancel POST userIdentifier lt user_id gt Required the user ID you want to use as credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier value 200 Ok Indicates the REST call executed without error See XML return content for whether all specified requests were canceled 401 Not authorized 404 Object not found 500 Server exception A request can only be cancelled if its state is PENDING Note e When a pending subscription modification request is canceled only the modification is canceled the subscription is not ch
3. catalog lt catalog id gt request Use List catalogs on page 47 to get the catalog ID POST userIdentifier lt user_id gt 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 userldentifier on page 91 for the steps required to get the userldentifier value 200 Ok 401 Not authorized 404 Not found 500 Server exception Use the following URL HP Cloud Service Automation 4 10 Page 58 of 150 API Reference https lt host gt lt port gt csa rest catalog 9054029734f502880134f502c82e0011 request userIdentifier 90d96675s5f46a930135f35b327e00a0 The following XML was sent in the request lt ServiceRequest gt lt description gt description request BE lt description gt lt name gt Request BE Order server lt name gt lt displayName gt Request BE lt displayName gt lt artifactContext gt lt id gt 8a8181853824bc1d013824c3ae350078 lt id gt lt artifactContext gt lt requestedAction gt lt name gt ORDER lt name gt lt property gt lt name gt START_DATE lt name gt lt values gt lt value gt 2012 06 26T110 58 58 233 08 00 lt value gt lt values gt lt property gt lt property gt lt name gt END_DATE lt name gt lt values gt lt value gt 2012 06 30T10 58 58 233 08 00 lt value gt lt values gt lt property gt lt property gt lt name gt SERV
4. lt additionalSummaryMessages gt lt importResultRecord gt ea933ec5 ad7b 42b6 b47c 965ff76f7693 lt importResultRecord gt lt importStatus gt SUCCESS lt importStatus gt lt importSummary gt Import of Service offering archive successful lt importSummary gt lt ImportOperationResult gt HP Cloud Service Automation 4 10 Page 81 of 150 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 Usethis 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 Base URL https lt host gt lt port gt csa rest Details URI importzip Method POST HP Cloud Service Automation 4 10 Page 82 of 150 API Reference Parameters userIdentifier lt user_id gt Returns Required the user ID you want to use as credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier value file lt file_name gt 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
5. lt name gt ProjectManager lt name gt lt organization gt lt id gt 8a81818f3d1421e7013d1423635a0003 lt id gt lt objectId gt 8a81818F3d1421e7013d1423635a0003 lt objectId gt lt isCriticalSystemObject gt false lt isCriticalSystemObject gt lt name gt QA_ORG_1 lt name gt lt displayName gt QA Org 1 lt displayName gt lt disabled gt false lt disabled gt lt organization gt lt approver gt lt NamedApproverApprovalTemplate gt Delete approval policy Details URI organization lt organization_id gt approvalPolicy lt policy_id gt Method DELETE Parameters userIdentifier lt user_id gt Required the user ID you want to use as credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier value Returns 200 Ok 401 Not authorized 404 Object not found 500 Server exception HP Cloud Service Automation 4 10 Page 112 of 150 API Reference Example The following URL was sent https lt host gt lt port gt csa rest organization 8a81818f3d1421e7013d142363520003 approvalPolicy 8a81818f3d1437e2013d17f249c30a0c userIdentifier 90d96588360da0c701360da0f1d5f483 The following XML was returned lt xml version 1 0 encoding UTF 8 standalone yes gt lt NamedApproverApprovalTemplate gt lt id gt 8a81818f3d1437e2013d17f249c30a0c lt id gt lt objectId gt 82a81818f3d1437e2013d17f249c30a0c lt objectId gt lt createdOn gt 2013 02 26711 19 47
6. si u cd decis ceeded eedebbessdeueveeeidecds 14 Delete an artifact 2 2 eee 17 Retrieve a predefined view for an artifact 0000000000 0000 17 Retrieve resolved properties for an artifact 0 0 0000000 0000 19 List active groups associated with an organization 0000 000 0 cece cece eeeeeee 22 Add groups to an organization 0000 00 0000 0 000 rr rr 23 Update group display name distinguished name 25 Delete or disassociate group from an organization 2200000 e cece cece ee eee 26 list TESOUNCE eee 2 essere fe a a ord 27 Add document to service Trening 0000 28 Delete document from service offering cece cece e eee eeeeeeees 30 Update document in service offering 000 000 cece cece cece cece cece cece ee eeeees 31 Publish service offerings to catalog 0 00 00 0000 cece cee eeeeees 31 Unpublish service offerings from catalog 00 00 0000 eee ce cece eee 33 Retrieve artifact state and status 0000 0 35 ANAS A OVE dt ot Jee 36 Chapter 2 Availablevalues ADI 42 Chapter3 Catalog 3 4 a a ss eed a 44 HP Cloud Service Automation 4 10 Page 3 of 150 API Reference Contents A R sa 44 CAA OG til ceed tainted a et ra A La Dedo cala ade a il E dc 44 SEE AAA AI II NS Nee eles Asta eS a 44 OMS cun Shits setae natn da ee lia N
7. Delete or disassociate group from an organization Use this URI to delete a group or to disassociate it from an organization If no organization is associated with this group the group will be deleted Otherwise the group will be disassociated from the specified organization Details URI artifact lt organization_id gt group lt group_id gt Method DELETE Parameters userIdentifier lt user_id gt Required the user ID you want to use as credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier value Returns 200 Ok 401 Not authorized 404 Object not found 500 Server exception Example The following URL was sent https lt host gt lt port gt csa rest artifact 8a81818F3d1421e7013d1423635ae003 group 8 a81818f3d1437e2013d1795d41107ea userIdentifier 90d96588360da0c701360da0f1d5f483 The following XML was returned lt messageList gt lt messages gt Removed role association for My New Group Name lt messages gt lt messageList gt HP Cloud Service Automation 4 10 Page 26 of 150 API Reference List resource providers Details URI artifact Method GET Parameters userIdentifier lt user_id gt Required the user ID you want to use as credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier value artifactType RESOURCE_PROVIDER Required the only valid value is RESOURCE_PROVIDER Basic view
8. URI Method Parameters Description artifact lt service_offering_ POST userldentifier Add document to service id gt document offering on page 28 lartifact lt service offering DELETE userldentifier Delete document from id gt document service offering on page 30 lartifact lt service_offering POST userldentifier Update document in service id gt document lt document_id gt offering on page 31 artifact lt catalog_id gt publish POST userldentifier Publish service offerings to catalog on page 31 artifact lt catalog_id gt unpublish POST userldentifier Unpublish service offerings from catalog on page 33 Note You can view information about an artifact with GET artifact lt artifact_id gt or GET artifact fastview lt artifact_id gt The fastview API can traverse associations while the standard artifact API only returns information for the artifact Artifact types You can work with the following artifact types using the artifact API You can use them with the methods marked in the table Artifact type GET POST PUT DELETE Approval process X HP Cloud Service Automation 4 10 Page 10 of 150 API Reference Artifact type GET POST PUT DELETE Approval template X Approver X Catalog X X X X Document X X X Group X Named approver approval template X Organization X X X X Person X Resource binding X X Resource environment X Resource offering X X X Resource pool X X X X Resource provider X X X X Resourc
9. lt subscriptionStatus gt lt initiatingServiceRequest gt lt initiatingServiceRequest gt lt basePrice xsi type recurrentPricingVO gt lt basePrice gt lt basePrice xsi type initialPricingVO gt lt basePrice gt lt totalPrice xsi type recurrentPricingVO gt lt totalPrice gt lt totalPrice xsi type initialPricingVO gt lt totalPrice gt lt pricingModel gt lt pricingModel gt lt associatedRequest gt lt id gt 90e396c832a4cfd80013a4d06e29702bc lt id gt lt name gt Test Modify subscription lt name gt lt associatedRequest gt lt associatedRequest gt lt id gt 90e396c832a4cfd80013a4d017e740003 lt id gt lt name gt Test2 Modify subscription lt name gt lt associatedRequest gt lt ServiceSubscription gt HP Cloud Service Automation 4 10 Page 73 of 150 API Reference List instances in the catalog Deprecation Notice The GET catalog lt catalog_id gt 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 lt catalog_id gt instance Use List catalogs on page 47 to get the catalog ID Method GET Parameters userIdentifier lt user_id gt 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 t
10. lt paramRoleType gt lt isCriticalSystemObject gt lt isCriticalSystemObject gt lt name gt lt name gt lt disabled gt lt disabled gt HP Cloud Service Automation 4 10 Page 118 of 150 API Reference lt paramRoleType gt lt scope gt lt isCriticalSystemObject gt lt isCriticalSystemObject gt lt name gt lt name gt lt scope gt lt valueType gt lt isCriticalSystemObject gt lt isCriticalSystemObject gt lt name gt lt name gt lt disabled gt lt disabled gt lt valueType gt lt values gt lt value gt lt value gt lt values gt lt maxOccurs gt lt maxOccurs gt lt minOccurs gt lt minOccurs gt lt orderIndex gt lt orderIndex gt lt confidential gt lt confidential gt lt encrypted gt lt encrypted gt lt readOnly gt lt readOnly gt lt property gt lt processDefinition gt lt id gt lt id gt lt name gt lt name gt lt processDefinition gt lt processInstanceState gt lt isCriticalSystemObject gt lt isCriticalSystemObject gt lt name gt lt name gt lt disabled gt lt disabled gt lt processInstanceState gt lt context gt lt context gt lt ProcessInstance gt Retrieve a process instance Details URI processinstances lt process instance id gt Where lt process instance id gt is the process instance ID Method GET Parameters None Response Body Returns Processlnstance VO 200 Ok 401 Not authorized 404
11. lt utilization gt lt resourceBindingId gt 90e72d913d936a9a013d937bdb570161 lt resourceBindingId gt lt resourcePool gt lt id gt 90e72d913d936292013d936c74040006 lt id gt lt objectId gt 90e72d913d936292013d936c74040006 lt objectId gt HP Cloud Service Automation 4 10 Page 145 of 150 API Reference lt isCriticalSystemObject gt false lt isCriticalSystem0bject gt lt name gt Pool 1 March 22 2013 6 46 31 PM UTC lt name gt lt displayName gt Pool 1 lt displayName gt lt disabled gt false lt disabled gt lt poolReference gt poolref lt poolReference gt lt resourcePool gt lt resourceProvider gt lt id gt 90e72d913d936a9a013d936c262be004 lt id gt lt objectId gt 90e72d913d936a9a013d936c262b0004 lt objectId gt lt isCriticalSystem0bject gt false lt isCriticalSystemObject gt lt name gt Provider_1 March 22 2013 6 46 11 PM UTC lt name gt lt displayName gt Provider 1 lt displayName gt lt disabled gt false lt disabled gt lt resourceProvider gt lt resourceType gt lt id gt 6A883A543D1248DDBB6045AD6A06BEA2 lt id gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt description gt Megabytes of memory lt description gt lt name gt MEMORY lt name gt lt displayName gt Memory lt displayName gt lt disabled gt false lt disabled gt lt resourceType gt lt serviceComponentId gt 90e72d913d936a9a013d937bdb56015a lt serviceComponentId gt lt serviceInstanceId gt 90e72d913d936a9a013d93
12. 500 Server exception Update approval decision using an external approval system Details URI Method Parameters catalog lt calalog id gt approval lt approval id gt 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 PUT userIdentifier lt user_id gt 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 userldentifier on page 91 for the steps required to get the userldentifier value HP Cloud Service Automation 4 10 Page 65 of 150 API Reference URI catalog lt calalog_id gt approval lt approval_id gt 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 Returns 200 Ok 401 Not authorized 404 Not found 500 Server exception Examples The following URL was sent to approve a subscription request https lt host gt lt port gt csa rest catalog 9054029734f502880134f502c82e0011 approval 65920b6356n204770943t567ss2r1503 userIdentifier 90d9667ss5f46a930135f35b327e00a0 The following XML was sent in the request lt ApprovalProcess gt lt approvalResult gt lt name gt APPROVED lt name gt lt approvalResult gt lt ApprovalProcess gt The f
13. Category Categories allow you to classify service offerings in a service catalog URI Method Parameters Description catalog lt catalog_id gt category POST userldentifier Create catalog categories on page 50 catalog lt catalog_ PUT userldentifier Update catalog categories id gt category lt category_id gt on page 52 catalog lt catalog_ DELETE userldentifier Delete catalog category on id gt category lt category_id gt page 53 Offering An offering allows you to define service designs that are published to a service catalog HP Cloud Service Automation 4 10 Page 44 of 150 API Reference URI catalog lt catalog_ id gt offering catalog lt catalog_ id gt offering lt offering_id gt Request Method GET GET Parameters userldentifier scope detail hasApproval userldentifier scope detail Description List offerings in the catalog on page 54 Get offering details on page 55 A request is created whenever a user initiates changes or deletes a subscription URI Method Parameters Description catalog lt catalog_id gt request GET userldentifier scope List requests in the detail submitter catalog on page 56 catalog lt catalog_id gt request POST userldentifier Submit a request on page 58 catalog lt catalog_ GET userldentifier scope Get request details on id gt request lt request_id gt detail page 60 catalog lt catalog_ GET userldentifier Cancel a req
14. disabled gt lt Organization gt HP Cloud Service Automation 4 10 Page 117 of 150 Chapter 13 Processinstances API Description The Processinstance API is used to return execution results from HP Operations Orchestration flows When HP Operations Orchestration makes one of these REST calls the process instance properties are updated accordingly When the process completes the process notification handler passes these properties to the caller Base URL https lt host gt lt port gt csa rest URIs The following URIs are appended to the base URL URI Method Parameters processinstances lt process _ GET None instance_id gt processinstances POST userldentifier processinstances lt process _ PUT userldentifier instance_id gt scope view action processinstances lt process _ POST userldentifie instance_id gt execute Process Instance structure XML structure Description Retrieve a process instance on the next page Create a process instance on page 121 Update a process instance on page 122 Execute a process instance on page 125 An abbreviated version of the XML for a process instance is provided below Only properties that are relevant for APIs are shown the XML returned by an API call will usually include much more than what is shown here lt ProcessInstance gt gt lt property gt lt isCriticalSystemObject gt lt isCriticalSystemObject gt lt name gt lt name gt
15. notifContentBody gt lt notifSubject gt Your subscription is now active lt notifSubject gt lt notifactionId gt 90d957ea3806fa7e01380f95d38d073a lt notifactionId gt lt recepientId gt BFA0DB53DA414B90E04059106D1A24B5 lt recepientId gt lt recepientName gt consumer lt recepientName gt lt senderContextArtifactName gt CSA CONSUMER lt senderContextArtifactName gt lt senderContextArtifactTypeName gt ORGANIZATION lt senderContextArtifactTypeNa me gt lt tokens gt lt tokenSequence gt lt tokenSequence gt lt value gt my request lt value gt lt token s gt lt tokens gt lt tokenSequence gt 1 lt tokenSequence gt lt value gt CSA Consumer lt value gt lt tok ens gt lt notification gt lt NotificationList gt Send notification Details URI notification party lt party_id gt Method POST HP Cloud Service Automation 4 10 Page 95 of 150 API Reference URI notification party lt party_id gt Parameters userIdentifier lt user_id gt 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 userldentifier on page 91 for the steps required to get the userldentifier value Returns 200 Ok 401 Not authorized 500 Server exception Request body format lt Notification gt lt subject gt Notification Subject goes in here lt subject gt lt contentBody gt Enter any text here option
16. using componentfinalize view Note If you are updating with artifact views you need to specify all the view s properties The following predefined views are available View name accesspoint actioninfo Properties accessPoint username accessPoint password accessPoint uri accessPoint category name action actionState name action actionStatus action errorOnTimeout action failOnError action timeout action processDefinition name action consumerVisible action stateConstraint lifecycleState name action stateConstraint lifecycleSubstate name HP Cloud Service Automation 4 10 Description This retrieves information from the access point object Any entity that has the accessPoint property should work with this view Retrieves the properties for the action object in addition to all the basicinfo and propertyinfo properties Note If the intention is to update an existing action then action id must be specified Page 37 of 150 API Reference View name artifactinfo basicinfo candidatepools candidateprovid ers Properties state name artifactType name disabled ownedBy name id name displayName description iconUrl detailedDescription isCriticalSystemObject resourceBinding candidateProvider candidatePool id resourceBinding candidateProvider candidatePool objectld resourceBinding candidateProvider candidatePool isCriticalS ystemObject resourceBinding candid
17. 00 lt updatedOn gt lt isCriticalSystemObject gt false lt isCriticalSystemObject gt lt description gt SD2 Offering lt description gt lt detailedDescription gt desc SD2 offering lt detailedDescription gt lt iconUr1 gt csa images library application png lt iconUr1 gt lt name gt request 1 lt name gt HP Cloud Service Automation 4 10 Page 57 of 150 API Reference lt displayName gt request 1 lt displayName gt lt state gt lt id gt 90d96588360da0c701360da0ef470038 lt id gt lt objectId gt 90d96588360da0c701360da0ef470038 lt objectId gt lt createdOn gt 2012 06 21711 51 43 267 07 00 lt createdOn gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt description gt Active lt description gt lt iconUr1 gt csa images categories artifact_state active png lt iconUr1 gt lt name gt ACTIVE lt name gt lt displayName gt Active lt displayName gt lt disabled gt false lt disabled gt lt categoryType gt lt id gt 90d96588360da0c701360da0ef420037 lt id gt lt objectId gt 90d96588360da0c701360da0ef420037 lt objectId gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt name gt ARTIFACT_STATE lt name gt lt displayName gt Artifact State lt displayName gt lt extensible gt false lt extensible gt lt categoryType gt lt state gt lt ServiceRequest gt lt ServiceRequestList gt Submit a request Details URI Method Parameters Returns Examples
18. 147 Some API calls do not support all possible values for this parameter 200 Ok 401 Not authorized 404 Not found 500 Server exception Use the following URL https lt host gt lt port gt csa rest catalog 402895e566cb32ss0136cb831752000f userIdentifier 90d9652b35f46a930135f35b327e00a08scope basegdetail required The following XML was returned in the response lt xml version 1 0 encoding UTF 8 standalone yes gt gt lt Catalog gt lt id gt 402895e345cb67dd9136ss331752000f lt id gt lt objectId gt 402895e345cb67dd0136ss331752000F lt objectId gt lt isCriticalSystemObject gt false lt isCriticalSystem0bject gt lt name gt Catalog Consumer_A lt name gt lt displayName gt Consumer Catalog A lt displayName gt lt state gt HP Cloud Service Automation 4 10 Page 49 of 150 API Reference lt id gt 90d96567360da0c701360ss0ef470038 lt id gt lt objectId gt 90d96567360da0c701360ss0ef470038 lt objectId gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt name gt ACTIVE lt name gt lt displayName gt Active lt displayName gt lt disabled gt false lt disabled gt lt categoryType gt lt id gt 90d67588360da0c701360ss0ef420037 lt id gt lt objectId gt 90d67588360da0c701360ss0ef420037 lt objectId gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt name gt ARTIFACT_STATE lt name gt lt displayName gt Artifact State lt displayName gt lt extensible
19. URI Method Parameters notification party lt party_id gt Where the party ID is the UUID of a person organization or group See How to find a party ID GET userIdentifier lt user_id gt 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 userldentifier on page 91 for the steps required to get the userldentifier value maxResults lt n gt Optional where n is the number of notification objects to return Notification objects are ordered by createdOn date with most recent first By default all notification objects will be returned HP Cloud Service Automation 4 10 Page 94 of 150 API Reference URI notification party lt party_id gt Where the party ID is the UUID of a person organization or group See How to find a party ID Returns 200 Ok 401 Not authorized 500 Server exception Examples The following URL was sent https lt host gt lt port gt csa rest notification party BFA0DB53DA414B90E04059106D1A24 B5 userIdentifier BFAODB53DA414B90E04059106D1A24B5 The following XML was returned lt xml version 1 0 encoding UTF 8 standalone yes gt gt lt NotificationList gt lt notification gt lt notifContentBody gt Your service subscription for 0 is now active To vi ew the details or make modifications go to the 1 and click the Subscriptions tab lt
20. displayName is required e conUrl and description are optional and will be set to null if not specified Example The following URL was sent to create an approval policy with two named approvers https lt host gt lt port gt csa rest catalog 90e72e323c88421f013c8d7fad120076 category userIdentifier 90d96588360da0c701360da0f1d5f483 The following XML was sent in the request lt Catalog gt lt catalogCategory gt lt displayName gt Example first Catalog Category lt displayName gt lt iconUr1 gt catalog category x png lt iconUr1 gt lt description gt description for catalog category lt description gt lt catalogCategory gt lt catalogCategory gt lt displayName gt Example second category lt displayName gt lt catalogCategory gt lt Catalog gt The following XML was returned lt xml version 1 0 encoding UTF 8 standalone yes gt lt Catalog gt lt id gt 8a81818f3d02fb7e013d0308894a0004 lt id gt lt isCriticalSystemObject gt false lt isCriticalSystem0bject gt lt description gt Default catalog for the organization lt description gt lt iconUr1 gt csa images library briefcase consumer_default_img 60 png lt iconUr1 gt lt name gt Catalog QA ORG lt name gt lt displayName gt QA Org Catalog lt displayName gt lt catalogCategory gt lt catalogCategory gt lt catalogCategory gt lt id gt 8a81818F3d128500013d1341a5d3000e lt id gt lt isCriticalSystemObject gt false lt isCritic
21. following was sent to update the process instance state https lt host gt lt port gt csa rest processinstances 90d9652b362d4ecd01362d4fb7be0f71 userIdentifier 90d96588360da0c701360da0f1d5f4838scope vieweview processinstance state amp action merge lt ProcessInstance gt gt lt id gt 90d9652b3752ad4f013752ae38cb0065 lt id gt lt processInstanceState gt lt name gt COMPLETED lt name gt lt processInstanceState gt lt ProcessInstance gt The following was sent to update the process instance return code https lt host gt lt port gt csa rest processinstances 90d9652b3752ad4f013752ae38cb0065 userIdentifier 90d96588360da0c701360da0f1d5f4838scope vieweview processinstance state amp action merge lt ProcessInstance gt gt lt id gt 90d9652b3752ad4f013752ae38cb0065 lt id gt lt processReturnCode gt lt name gt SUCCESS lt name gt lt processReturnCode gt lt ProcessInstance gt The following was sent to update the process instance state status and retum code HP Cloud Service Automation 4 10 Page 124 of 150 API Reference userIdentifier 90d96588360da0c701360da0f1d5f4838scope vieweview processinstance state amp action merge lt ProcessInstance gt gt lt id90d9652b3752ad4f013752ae38cb0065 lt id gt lt processInstanceState gt lt name gt COMPLETED lt name gt lt processInstanceState gt lt processReturnCode gt lt name gt SUCCESS lt name gt lt processReturnCode gt lt status gt The Pr
22. gt 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 userldentifier on page 91 for the steps required to get the userldentifier value file lt multipart_representation_of_service_offering zip file gt Required type Multipart Form Data 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 update true false Optional default is false If true any existing artifacts of the same type and with the same name will be overwritten otherwise the artifacts are created Cannot be used with updatePreserveExisting parameter updatePreserveExisting true false Optional default is false If true any existing artifacts of the same type with the same name will be preserved not overwritten and renamed Existing references to these artifacts will automatically use the renamed artifacts New artifacts are created from the archive Cannot be used with update parameter orgForCatalogImport lt organization_name gt Required for import of catalog archive the name of the organization to be used when creating the imported catalog associateProviders true false Optional default is false If true resource providers in the archive are bound to existing resource offeri
23. gt lt id gt 90d96588372d758101372d75aeb90087 lt id gt lt objectId gt 90d96588372d758101372d75aeb90087 lt objectId gt lt isCriticalSystemObject gt false lt isCriticalSystemObject gt lt disabled gt false lt disabled gt lt serviceInstance gt lt targetState gt lt id gt 90d96588360da0c701360da0f23700bb lt id gt lt objectId gt 90d96588360da0c701360da0f23700bb lt objectId gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt name gt DEPLOYED lt name gt lt disabled gt false lt disabled gt lt categoryType gt lt id gt 90d96588360da0c701360da0F21300ae lt id gt lt objectId gt 90d96588360da0c701360da0f21300ae lt objectId gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt name gt LIFECYCLE_STATE lt name gt lt extensible gt false lt extensible gt lt categoryType gt lt targetState gt lt LifecycleExecutionRecord gt HP Cloud Service Automation 4 10 Page 88 of 150 API Reference Get latest lifecycle execution record for a service instance Details URI lifecycleengine Method GET Parameters userIdentifier lt user_id gt Required the user ID you want to use as credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier value serviceInstanceId lt service_instance_id gt Required the ID of the service instance Returns 200 Ok 401 Not authorized 404 Not found 500 Server exception Schedu
24. gt lt serviceBlueprint gt lt detailedDescription gt 3 Level Option for testing service offerings Integratio n Service Offering lt detailedDescription gt lt iconUr1 gt csa images library compliance png lt iconUr1 gt lt name gt ServiceOffering for ApprovalPolicy lt name gt lt displayName gt ServiceOffering for ApprovalPolicy lt displayName gt lt state gt lt state gt lt artifactType gt lt artifactType gt lt disabled gt false lt disabled gt lt offeringState gt lt offeringState gt lt ServiceOffering gt lt ServiceOffering gt lt ServiceOffering gt lt ServiceOffering gt lt ServiceOffering gt lt ServiceOfferingList gt Get offering details Details URI catalog lt catalog id gt offering lt offering id gt 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 Method GET HP Cloud Service Automation 4 10 Page 55 of 150 API Reference URI Parameters Returns Examples catalog lt catalog_id gt offering lt offering_id gt 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 userIdentifier lt user_id gt 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 userldentifier on page 9
25. gt false lt automaticApproval gt lt automaticPeriodDuration gt lt automaticPeriodDuration gt lt automaticApprovalDecision gt lt name gt REJECTED lt name gt lt automaticApprovalDecision gt lt NamedApproverApprovalTemplate gt The following XML was returned lt xml version 1 0 encoding UTF 8 standalone yes gt lt NamedApproverApprovalTemplate gt lt id gt 8a81818f3d1437e2013d17f249c30a0c lt id gt lt objectId gt 8a81818f3d1437e2013d17f249c30a0c lt objectlId gt lt createdOn gt 2013 02 26111 19 47 397 08 00 lt createdOn gt lt updatedOn gt 2013 02 26T11 45 06 900 08 00 lt updatedOn gt lt name gt My New Approval Template_February 26 2013 7 19 47 PM UTC lt name gt lt displayName gt Updated My Approval Template lt displayName gt lt automaticApproval gt false lt automaticApproval gt lt automaticPeriodDuration gt lt automaticPeriodDuration gt lt minApprovalRequired gt 1 lt minApprovalRequired gt HP Cloud Service Automation 4 10 Page 111 of 150 API Reference lt approvalType gt lt id gt 90d96588360da0c701360da0f0b00093 lt id gt lt name gt NAMED_APPROVER_TEMPLATE lt name gt lt approvalType gt lt automaticApprovalDecision gt lt id gt 90d96588360da0c701360da0f091008c lt id gt lt name gt REJECTED lt name gt lt displayName gt Denied lt displayName gt lt automaticApprovalDecision gt lt approver gt lt id gt 8a81818f3d1437e2013d177b13f107dd lt id gt
26. gt false lt extensible gt lt categoryType gt lt state gt lt artifactType gt lt id gt 90d96586760da0c701360da0ssd2001d lt id gt lt objectId gt 90d96586760da0c701360da0ssd2001d lt objectId gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt name gt CATALOG lt name gt lt displayName gt Catalog lt displayName gt lt disabled gt false lt disabled gt lt categoryType gt lt id gt 90d67588360da0c701360da0ssb40017 lt id gt lt objectId gt 90d67588360da0c701360da0ssb40017 lt objectId gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt name gt ARTIFACT_TYPE lt name gt lt displayName gt Artifact Type lt displayName gt lt extensible gt false lt extensible gt lt categoryType gt lt artifactType gt lt disabled gt false lt disabled gt lt Catalog gt Create catalog categories Details URI Method catalog lt catalog id gt category POST Parameters userIdentifier lt user_id gt Required the user ID you want to use as credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier value HP Cloud Service Automation 4 10 Page 50 of 150 API Reference URI catalog lt catalog_id gt category Returns 200 Ok 401 Not authorized 404 Object not found 500 Server exception In the request body e Any category specified in the request body that already exists will be left unchanged e
27. information is provided in the return content Returns 200 Ok 401 Not authorized 500 Server exception Example The following URL was sent https lt host gt lt port gt csa rest artifact userIdentifier 90d96588360da0c701360da0F1d5f483 amp artifactType RESOURCE_PROVIDER The following XML was returned in the response lt ResourceProviderList gt lt count gt 3 lt count gt lt limit gt lt limit gt lt resourceProvider gt lt id gt 90e72e583d4c6e77013d4c96b1ab0010 lt id gt lt objectId gt 90e72e583d4c6e77013d4c96b1ab0010 lt objectId gt lt isCriticalSystemObject gt false lt isCriticalSystem0bject gt lt description gt Sitescope A lt description gt lt name gt Sitescope A March 9 2013 12 39 36 AM UTC lt name gt lt displayName gt Sitescope A lt displayName gt lt disabled gt false lt disabled gt lt resourceProvider gt lt ResourceProviderList gt HP Cloud Service Automation 4 10 Page 27 of 150 API Reference Add document to service offering Details URI artifact lt service offering id gt document Method POST Parameters userIdentifier lt user_id gt Required the user ID you want to use as credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier value Returns 200 Ok 401 Not authorized 404 Object not found 500 Server exception Example The following URL was sent with headers e Content type multipart fo
28. lt name gt lt displayName gt Changing first example category name lt displayName gt lt disabled gt false lt disabled gt lt catalogCategory gt lt Catalog gt Delete catalog category Details URI catalog lt catalog id gt category lt category id gt Method DELETE Parameters userIdentifier lt user_id gt Required the user ID you want to use as credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier value Returns 200 Ok Indicates the REST call executed without error See XML return content for details on category deleted 401 Not authorized 404 Object not found 500 Server exception HP Cloud Service Automation 4 10 Page 53 of 150 API Reference Example The following URL was sent https lt host gt lt port gt 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 lt catalog_id gt offering Use List catalogs on page 47 to get the catalog ID Method GET Parameters userIdentifier lt user_id gt 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 f
29. lt value gt lt values gt lt maxOccurs gt lt maxOccurs gt lt minOccurs gt lt minOccurs gt lt orderIndex gt lt orderIndex gt lt confidential gt false lt confidential gt lt encrypted gt false lt encrypted gt lt consumerReadOnly gt false lt consumerReadOnly gt lt consumerVisible gt false lt consumerVisible gt lt property gt lt property gt lt property gt lt property gt lt property gt lt Properties gt The following URL was used to retrieve a single property https lt host gt lt port gt csa rest artifact lt id gt resolveProperties userIdentifier lt user_id gt amp propertyName PARENT_SVC_COMPONENT_ID The following XML was returned in the response lt xml version 1 0 encoding UTF 8 standalone yes gt lt Properties gt lt property gt lt id gt 90d9651a3684c7f0013684cafda80005 lt id gt lt name gt PARENT_SVC_COMPONENT_ID lt name gt lt property gt lt Properties gt HP Cloud Service Automation 4 10 Page 21 of 150 API Reference List active groups associated with an organization Details URI artifact lt organization_id gt group Method GET Parameters userIdentifier lt user_id gt Required the user ID you want to use as credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier value Returns 200 Ok 401 Not authorized 404 Object not found 500 Server exception Example T
30. lt host gt lt port gt csa rest artifact 8a81818f3d02fb7e013d9308891d0003group 8a 81818f3d1437e2013d1795d41107ea userIdentifier 90d96588360da0c701360da0f1d5f483 The following XML was sent lt GroupList gt lt group gt lt displayName gt My New Group Name lt displayName gt lt distinguishedName gt cn TestConsumer ou ConsumerGroup ou CSAGroups lt distinguishedName gt lt group gt lt GroupList gt The following XML was returned lt xml version 1 0 encoding UTF 8 standalone yes gt lt Group gt lt id gt 8a81818f3d1437e2013d1795d41107ea lt id gt lt isCriticalSystemObject gt false lt isCriticalSystem0bject gt lt name gt sc_February 22 2013 5 54 43 PM UTC lt name gt lt displayName gt My New Group Name lt displayName gt lt state gt lt id gt 90d96588360da0c701360da0eF470038 lt id gt lt isCriticalSystemObject gt false lt isCriticalSystem0bject gt lt name gt ACTIVE lt name gt HP Cloud Service Automation 4 10 Page 25 of 150 API Reference lt disabled gt false lt disabled gt lt state gt lt artifactType gt lt id gt 90d96588360da0c701360da0eeff002b lt id gt lt isCriticalSystemObject gt false lt isCriticalSystemObject gt lt name gt GROUP lt name gt lt disabled gt false lt disabled gt lt artifactType gt lt disabled gt false lt disabled gt lt distinguishedName gt cn TestConsumer ou ConsumerGroup ou CSAGroups lt distinguishedName gt lt Group gt
31. lt isCriticalSystemObject gt false lt isCriticalSystemObject gt lt name gt HP Cloud Service Automation 4 10 Page 109 of 150 API Reference My New Approval Template_February 26 2013 7 19 47 PM UTC lt name gt lt displayName gt My New Approval Template lt displayName gt lt state gt lt state gt lt artifactType gt lt id gt 90d96588360da0c701360da0eef20027 lt id gt lt objectId gt 90d96588360da0c701360da0eef20027 lt objectId gt lt createdOn gt 2013 02 25117 32 55 667 08 00 lt createdOn gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt description gt Approval Template lt description gt lt artifactType gt lt ownedBy gt lt ownedBy gt lt disabled gt false lt disabled gt lt automaticApproval gt true lt automaticApproval gt lt automaticPeriodDuration gt 14 lt automaticPeriodDuration gt lt minApprovalRequired gt 2 lt minApprovalRequired gt lt approvalType gt lt id gt 90d96588360da0c701360da0f0b00093 lt id gt lt objectId gt 90d96588360da0c701360da0f0b00093 lt objectId gt lt createdOn gt 2013 02 25117 32 55 620 08 00 lt createdOn gt lt isCriticalSystemobject gt true lt isCriticalSystemobject gt lt description gt Named Approver Template lt description gt lt approvalType gt lt automaticApprovalDecision gt lt automaticApprovalDecision gt lt approver gt lt id gt 8a81818f3d1437e2013d17eec74408d8 lt id gt lt userName gt BudgetManage
32. lt organization_name gt userLookup Method GET Parameters userName lt user_name gt Required the user name you want to use as credentials for CSA Returns 200 Ok 401 Not authorized 404 Not found 500 Server exception Example To get the userldentifier we used the following URL https lt host gt lt port gt csa rest login MyOrganization userLookup userName admin domain The following XML was returned in the response lt xml version 1 0 encoding UTF 8 standalone yes gt lt person gt lt id gt 90s96588670da0c701360da0f1d540a1 lt id gt lt This is userIdentifier gt lt Remaining XML is not relevant for this example gt lt person gt HP Cloud Service Automation 4 10 Page 92 of 150 API Reference The value for userIdentifier is the first lt id gt value returned in the XML HP Cloud Service Automation 4 10 Page 93 of 150 Chapter 10 Notification API Description Use this API to retrieve the notification objects associated with lt party_id gt or to send a notification to users or organizations Base URL https lt host gt lt port gt csa rest URIs The following URIs are appended to the base URL URI Method Parameters Description Inotification party lt party_ GET userldentifier View list of notification objects id gt maxResults below notification party POST userldentifier Send notification on page 96 View list of notification objects Details
33. on page 91 for the steps required to get the userldentifier value view lt view_type gt amp 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 lt _artifact_property gt _action_ merge Optional use the merge option with the action meta tag query parameter to update only a portion of the artifact The action meta tag can either be specified globally for the artifact by including parameter action merge orfora specific property e g property values action merge Returns 200 Ok 401 Not authorized 404 Not found 500 Server exception Note To completely update the artifact e replace the persistent artifact do not use the view or merge parameters and include all artifact content in the request body Note that if only a portion of the artifiact content is sent in the request body any unspecified content will be removed from the artifact To update a portion of the artifact e Usea pre defined view that contains a subset of the artifact properties only that subset of properties will be updated per the values specified in the request body See Artifact views on page 36 for a list of view types e 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
34. requests on page 137 List approvals for approver A subscription is created when a consumer requests a service offering and includes all of the options selected by the consumer when the subscription was initiated URI user mysubscription user subscription count user subscription user multipleSubscription delete POST HP Cloud Service Automation 4 10 Method Parameters GET GET GET userldentifier scope detail requestor returnRetired creationStartDate creationEndDate modificationStartDate modificationEndDate userldentifier userldentifier queryType userldentifier Description List subscriptions for user on page 138 Get count of subscriptions for user on page 140 Get list of recent or expiring soon subscriptions for user on page 141 Delete multiple subscriptions on page 141 Page 128 of 150 API Reference Instance An instance is created when a request is approved and includes details about the requested services such as the status of services IP addresses etc URI Method Parameters Description user myinstance GET userldentifier scope detail requestor List instances for returnRetired creationStartDate user on page 143 creationEndDate List service requests for subscription Details URI user instance lt instance_id gt request Retuns the list of service requests for the specified subscription A request s details will include information o
35. subscription details Details URI Method Parameters Returns catalog lt catalog id gt resourceSubscription lt resource_subscription_ id gt GET userIdentifier lt user_id gt 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 userldentifier on page 91 for the steps required to get the userldentifier value scope base baseplusone subtree 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 If value is subtree then the object and all of its descendants are returned detail required basic standard template full Optional default is full See Values for the detail parameter on page 147 Some API calls do not support all possible values for this parameter 200 Ok 401 Not authorized 500 Server exception HP Cloud Service Automation 4 10 Page 76 of 150 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 lt host gt lt port gt csa rest Details URI export lt artifact_id gt Method GET Parameters userIdentifier lt user_id gt Required the user ID you want to use as
36. the user whose request list will be returned by this call submitter must be in the same organization as the user specified by userldentifier returnRetired true false Optional default is false submitStartDate lt yyyy MM ddTHH mm ss gt Optional requests submitted on or after start date and time will be included in the return T serves as a separator between data and time Time will default to 00 00 00 if not specified Date and time are assumed to be in the time zone of the CSA server submitEndDate lt yyyy MM ddTHH mm ss gt Optional requests submitted before end date and time will be included in the return T serves as a separator between data and time Time will default to 00 00 00 if not specified Date and time are assumed to be in the time zone of the CSA server 200 Ok 401 Not authorized 500 Server exception The following URL was sent https lt host gt lt port gt csa rest user myrequest userIdentifier 8a81818538106992013 81076be5400a0 amp submitter acctgconsumer The following XML was returned in the response lt xml version 1 0 encoding UTF 8 standalone yes gt lt ServiceRequestList gt lt count gt 21 lt count gt lt limit gt lt limit gt lt ServiceRequest gt lt id gt 8a8181853810699a01381079190800a7 lt id gt HP Cloud Service Automation 4 10 Page 131 of 150 API Reference lt ob jectId gt 8a8181853810699a01381079190800a7 lt objectId gt lt createdOn gt 2012
37. 06 21T12 16 08 073 07 80 lt createdOn gt lt updatedOn gt 2012 06 21T12 16 50 787 07 00 lt updatedOn gt lt isCriticalSystemObject gt false lt isCriticalSystemObject gt lt de scription gt SD2 Offering lt description gt lt detailedDescription gt desc SD2 offering lt detailedDescription gt lt iconUr1 gt csa images library application png lt iconUr1 gt lt name gt request 1 lt name gt lt di lt st splayName gt request 1 lt displayName gt ate gt lt id gt 90d96588360da0c701360da0ef470038 lt id gt lt objectId gt 90d96588360da0c701360da0ef470038 lt objectId gt lt createdOn gt 2012 06 21711 51 43 267 07 00 lt createdOn gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt description gt Active lt description gt lt iconUr1 gt csa images categories artifact_state active png lt iconUr1 gt lt name gt ACTIVE lt name gt lt displayName gt Active lt displayName gt lt disabled gt false lt disabled gt lt categoryType gt lt id gt 90d96588360da0c701360da0ef420037 lt id gt lt objectId gt 90d96588360da0c701360da0ef420037 lt objectId gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt name gt ARTIFACT_STATE lt name gt lt displayName gt Artifact State lt displayName gt lt extensible gt false lt extensible gt lt categoryType gt lt state gt lt Serv lt ServiceRe iceRequest gt questList gt Get count of requests for user Details URI
38. 1 for the steps required to get the userldentifier value scope base baseplusone subtree 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 If value is subtree then the object and all of its descendants are returned detail required basic standard template full Optional default is full See Values for the detail parameter on page 147 Some API calls do not support all possible values for this parameter 200 Ok 401 Not authorized 404 Not found 500 Server exception Use the following URL https lt host gt lt port gt csa rest catalog 402895e33732af18013732b6F435006b offering 402895e337326d300137327ce1e30074 userIdentifier 90d9652b67ss6a930135f35b327e00a0 The following XML was returned in the response lt xml version 1 0 encoding UTF 8 standalone yes gt lt ServiceOffering gt lt id gt 402895e337326d300137327ce1e30074 lt id gt lt objectId gt 402895e337326d300137327ce1e30074 lt objectId gt lt createdOn gt 2012 05 09T10 44 34 147 06 00 lt createdOn gt lt updatedOn gt 2012 05 09T11 48 26 170 06 00 lt updatedOn gt lt ServiceOffering gt List requests in the catalog Deprecation Notice The GET catalog lt catalog_id gt request URI has been deprecated Use URI user myrequest instead as using the deprecated URI will not allow viewing requests created by users who previously ha
39. 3 11 32 17 PM U TC from category AABBCCDD failed Category doesn t exist lt messages gt lt messageList gt HP Cloud Service Automation 4 10 Page 34 of 150 API Reference Retrieve artifact state and status Details URI Method Parameters Request Body Return Body Returns artifact state lt artifact_id gt GET userIdentifier lt user_id gt Required the user ID you want to use as credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier value None ArtifactStatelnfo 200 Ok 401 Not authorized 404 Object not found 500 Server exception For all artifacts possible values for the returned artifactState are ACTIVE RETIRED The following state and status information will be returned for specific artifact types For service instance artifacts state will be returned and will contain one of the following values ACTIVE CANCELLED CANCELLING CANCEL_FAILED DEPLOYING EXPIRE_FAILED EXPIRING FAILED MODIFYING MODIFY_FAILED IN_PROGRESS PUBLIC_ACTION_FAILED RESERVED For service request artifacts HP Cloud Service Automation 4 10 Page 35 of 150 API Reference e State will be returned and will contain one of the following values s APPROVED CANCELLED COMPLETED IN_PROGRESS PENDING_APPROVAL REJECTED SUBMITTED e Status will be returned If no value was set a null value will be returned Otherwise it will contai
40. 397 08 00 lt createdOn gt lt updatedOn gt 2013 02 26T11 45 06 900 08 00 lt updatedOn gt lt name gt My New Approval Template_February 26 2013 7 19 47 PM UTC lt name gt lt displayName gt Updated My Approval Template lt displayName gt lt state gt lt id gt 90d96588360da0c701360da0ef4b0039 lt id gt lt objectId gt 90d96588360da0c701360da0ef4b0039 lt objectId gt lt createdOn gt 2013 02 25117 32 55 547 08 00 lt createdOn gt lt isCriticalSystemobject gt true lt isCriticalSystemobject gt lt description gt Retired lt description gt lt iconUr1 gt csa images categories artifact_state retired png lt iconUr1 gt lt name gt RETIRED lt name gt lt displayName gt Retired lt displayName gt lt disabled gt false lt disabled gt lt categoryType gt lt categoryType gt lt state gt lt NamedApproverApprovalTemplate gt Retrieve organization LDAP access point information Details URI organization accessPoint Method GET Parameters orgName lt organization_name gt Required the name of the organization for which the LDAP access point information is to be retrieved HP Cloud Service Automation 4 10 Page 113 of 150 API Reference URI Returns Example organization accessPoint 200 Ok 401 Not authorized 500 Server exception The following URL was sent https lt host gt lt port gt csa rest organization accessPoint orgName ACCOUNTING The following XML was returned lt xml ve
41. 4838scope basegdetail basic The following XML was returned lt OrganizationList gt lt count gt 3 lt count gt lt limit gt lt limit gt lt organization gt lt id gt 8a818185381069920138106dcdd00083 lt id gt lt objectId gt 8a818185381069920138106dcdd00003 lt objectId gt lt createdOn gt 2012 06 21T12 03 47 920 07 00 lt createdOn gt lt updatedOn gt 2012 06 21T12 04 10 597 07 00 lt updatedOn gt lt isCriticalSystemObject gt false lt isCriticalSystemObject gt lt description gt desc CSA organization lt description gt lt iconUr1 gt csa images library Earth_48 png lt iconUr1 gt lt name gt CSA lt name gt lt displayName gt CSA lt displayName gt lt state gt lt id gt 90d96588360da0c701360da0ef470038 lt id gt HP Cloud Service Automation 4 10 Page 100 of 150 API Reference lt objectId gt 90d96588360da0c701360da0ef470038 lt objectId gt lt createdOn gt 2012 06 21711 51 43 267 07 00 lt createdOn gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt description gt Active lt description gt lt iconUr1 gt csa images categories artifact_state active png lt iconUr1 gt lt name gt ACTIVE lt name gt lt displayName gt Active lt displayName gt lt disabled gt false lt disabled gt lt categoryType gt lt id gt 90d96588360da0c701360da0ef420037 lt id gt lt objectId gt 90d96588360da0c701360da0ef420037 lt objectId gt lt isCriticalSystemObject gt true lt isCriticalSystemObject
42. 4bf09b4 lt id gt lt catalog gt lt id gt 90d965c0379fd06601379fd193620f05 lt id gt lt catalog gt lt catalogItem gt lt ServiceSubscription gt lt ServiceSubscriptionList gt The following XML was returned count indicates the number of subscriptions successfully deleted A ServiceSubscription element is included for each deleted subscription To make this example more informative note in the following return information that the first subscription is not deleted A subscription will not be deleted during this call if the subscription was already deleted it is not in the canceled state permission is denied or there is an authorization failure lt ServiceSubscriptionList gt lt count gt 1 lt count gt lt limit gt lt limit gt lt ServiceSubscription gt lt id gt 90e72e283b05aff1013b0b2b43fc0356 lt id gt lt isCriticalSystemObject gt false lt isCriticalSystemObject gt lt disabled gt false lt disabled gt lt ServiceSubscription gt lt ServiceSubscriptionList gt HP Cloud Service Automation 4 10 Page 142 of 150 API Reference List instances for user Details URI Method Parameters Returns Examples user myinstance GET userIdentifier lt user_id gt 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 userldentifier on page 91 for the steps required to get the userldentifier value sc
43. 4f502c82e0011 approval 65920b6356n204770943t567ss2r1503 approver userIdentifier 90d9667ss5f46a930135f35b327e00a0 The following XML was sent in the request lt xml version 1 0 encoding UTF 8 standalone yes gt lt Approver gt lt person gt lt userName gt approver hp com lt userName gt lt organization gt lt name gt CSA_CONSUMER lt name gt lt organization gt lt person gt lt approverResult gt lt name gt APPROVED lt name gt lt approverResult gt lt Approver gt The following URL was sent to reject a subscription request https lt host gt lt port gt csa rest catalog 9054029734f502880134f502c82e0011 approval 65920b6356n204770943t567ss2r1503 approver userIdentifier 90d9667ss5f46a930135f35b327e00a0 The following XML was sent in the request lt xml version 1 0 encoding UTF 8 standalone yes gt lt Approver gt lt person gt lt userName gt approver hp com lt userName gt HP Cloud Service Automation 4 10 Page 67 of 150 API Reference lt organization gt lt name gt CSA_CONSUMER lt name gt lt organization gt lt person gt lt approverResult gt lt name gt REJECTED lt name gt lt approverResult gt lt approvalComment gt comment lt approvalComment gt lt Approver gt Update catalog approval policies Usethis API to associate an approval policy with the specified catalog Details URI Method Parameters Response Body Returns Example
44. 5382a26cc01382abf331c037e lt id gt lt isCriticalSystemObject gt false lt isCriticalSystemObject gt lt disabled gt false lt disabled gt lt ServiceRequest gt Get request details Details URI catalog lt catalog id gt request lt request id gt 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 HP Cloud Service Automation 4 10 Page 60 of 150 API Reference URI catalog lt catalog id gt request lt request id gt 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 lt user_id gt 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 userldentifier on page 91 for the steps required to get the userldentifier value scope base baseplusone subtree 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 If value is subtree then the object and all of its descendants are returned detail required basic standard template full Optional default is full See Values for the detail parameter on page 147 Some API calls do not support all possible values for this parameter Returns 201 Ok object returned 401 Not
45. 701360da0eedb0020 lt id gt lt objectId gt 90d96588360da0c701360da0eedb0020 lt objectId gt lt createdOn gt 2012 11 01715 16 57 787 07 00 lt createdOn gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt description gt Resource Environment lt description gt lt iconUrl gt csa images categories artifact_type resource_environment png lt iconUr1 gt lt name gt RESOURCE_ENVIRONMENT lt name gt lt displayName gt Resource Environment lt displayName gt lt disabled gt false lt disabled gt lt categoryType gt lt id gt 90d96588360da0c701360da0eeb40017 lt id gt lt objectId gt 90d96588360da0c701360da0eeb40017 lt objectId gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt name gt ARTIFACT_TYPE lt name gt lt displayName gt Artifact Type lt displayName gt lt extensible gt false lt extensible gt lt categoryType gt lt artifactType gt lt disabled gt false lt disabled gt lt numberOfProvider gt lt numberOfProvider gt lt numberOfServiceDesign gt lt numberOfServiceDesign gt lt numberOfCatalog gt lt numberOfCatalog gt lt ResourceEnvironment gt Update an artifact Details URI artifact lt artifact_id gt Method PUT HP Cloud Service Automation 4 10 Page 14 of 150 API Reference URI lartifact lt artifact_id gt Parameters userIdentifier lt user_id gt Required the user ID you want to use as credentials for this API call See Get userldentifier
46. 7bdb530138 lt serviceInstancelId gt lt unit gt lt id gt ED2CE3264F764F55877EEQCDFEE EFB4 lt id gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt description gt Megabytes lt description gt lt name gt MB lt name gt lt displayName gt MB lt displayName gt lt disabled gt false lt disabled lt unit gt lt usage gt 1024 lt usage gt lt utilization gt lt utilization gt lt utilization gt lt utilization gt lt utilization gt lt UtilizationList gt HP Cloud Service Automation 4 10 Page 146 of 150 Chapter 17 Values for the detail parameter The detail parameter has the following values 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 Basic In addition to the Required fields of an artifact retrieves nullable primitive types Java wrapper classes and Date Time TimeStamp and BigDecimal Standard In addition to the Basic fields of an artifact retrieves all non CSA type fields Template Retrieves all fields of an artifact except for artifact collection references and artifacts that are part of a containment relationship This is same as the Full option without artifact collection references This option is mainly used for performance reasons because you could end up retrieving a large amount of data For example you can use this option if you do no
47. 7f0013684cafda80005 lt id gt lt createdO0n gt 2012 04 05T16 15 57 480 07 00 lt createdOn gt lt updatedOn gt 2012 04 05T16 15 57 497 07 00 lt updatedOn gt lt isCriticalSystemObject gt false lt isCriticalSystemObject gt lt name gt PARENT_SVC_COMPONENT_ID lt name gt lt artifact gt lt id gt 90d9651a3684c7f0013684cafda80008 lt id gt lt isCriticalSystemObject gt false lt isCriticalSystemObject gt lt name gt TEST CHILD COMPONENT lt name gt lt disabled gt false lt disabled gt lt artifact gt lt propertyBindings gt lt id gt 90d9651a3684c7f0013684cb28820009 lt id gt HP Cloud Service Automation 4 10 Page 20 of 150 API Reference lt created0n gt 2012 04 05T16 16 08 450 07 00 lt createdOn gt lt updatedOn gt 2012 04 05T16 16 08 450 07 8 0 lt updatedOn gt lt propertyBindingType gt lt name gt SOURCE lt name gt lt categoryType gt lt name gt PROPERTY_BINDING_TYPE lt name gt lt categoryType gt lt propertyBindingType gt lt artifact gt 90d9651a3684c7f0013684c91f8c0004 lt artifact gt lt artifactPropertyName gt SVC_COMPONENT_ID lt artifactPropertyName gt lt propertyBindings gt lt scope gt lt scope gt lt valueType gt lt valueType gt lt values gt lt id gt 90d9651a3684c7f0013684c91f8b0002 lt id gt lt created0n gt 2012 04 05T16 13 55 083 07 00 lt createdOn gt lt updatedOn gt 2012 04 05T16 13 55 083 07 00 lt updatedOn gt lt value gt 90d9651a3684c7f0013684c91f8c0004
48. 93f07b880001 lt recepientId gt lt recepientName gt acctgconsumer lt recepientName gt lt senderContextArtifactId gt HP Cloud Service Automation 4 10 Page 97 of 150 API Reference 986cec3a03a93ef89013a93f07b880001 lt senderContextArtifactId gt lt senderContextArtifactTypeld gt 908d96588360da0c701360da0ef03002c lt senderContextArtifactTypeld gt lt senderContextArtifactTypeName gt PERSON lt senderContextArtifactTypeName gt lt source gt EXTERNAL lt source gt lt tokens gt lt tokenSequence gt 1 lt tokenSequence gt lt value gt Token 1 test content lt value gt lt tokens gt lt tokens gt lt tokenSequence gt lt tokenSequence gt lt value gt Token O test content lt value gt lt tokens gt lt notification gt lt NotificationPostResponse gt HP Cloud Service Automation 4 10 Page 98 of 150 Chapter 11 Organization API Description Use this API to view HP CSA organizations Base URL https lt host gt lt port gt csa rest URIs The following URIs are appended to the base URL URI organization organization lt organization_ id gt organization lt organization_ id gt approvalPolicy organization lt organization_ id gt approvalPolicy organization lt organization_ id gt approvalPolicy lt policy_ id gt organization lt organization_ id gt approvalPolicy lt policy_ id gt organization accessPoint organization offering HP Cloud Service Automat
49. ALIZED lt name gt lt disabled gt false lt disabled gt lt processInstanceState gt lt context gt Context for Unit Test Process Instance lt context gt lt artifactId gt ID of the artifact executing the action lt artifactId gt lt timeout gt 3600 lt timeout gt lt errorOnTimeout gt false lt errorOnTimeout gt lt ProcessInstance gt HP Cloud Service Automation 4 10 Page 120 of 150 API Reference Create a process instance Details URI processinstances Method POST Parameters userIdentifier lt user_id gt Required the user ID you want to use as credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier value Request ProcessInstance VO Body Response ProcessInstance VO Body Returns 200 Ok 401 Not authorized 404 Not found 500 Server exception The following must be provide in the request body e Process definition ID e Context string Includes contextual information that is relevant for the caller after the process instance has been created e Artifact ID e 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 e CSA PROCESS ID will be provided the value of the UUID of the process instance e CSA_CONTEXT_ID will be provided the value of the
50. API call See Get userldentifier on page 91 for the steps required to get the userldentifier value 200 Ok Indicates the REST call executed without error See XML return content for whether all specified approval requests were deleted 401 Not authorized 404 Object not found 500 Server exception An approval request can only be deleted if its state is APPROVED or DENIED Example The following URL was sent https lt host gt lt port gt csa rest user multipleApprovals delete userIdentifier 90d965c0379fd06601379fd192b30ee6 The following XML was sent in the request HP Cloud Service Automation 4 10 Page 137 of 150 API Reference lt ApprovalProcessList gt lt approvalProcess gt lt id gt 90e72e713a94e0ab013aae76618e00e39 lt id gt lt catalogItem gt lt catalog gt lt id gt 90d965c0379fd06601379fd193620f05 lt id gt lt catalog gt lt catalogItem gt lt approvalProcess gt lt approvalProcess gt lt id gt 90e2a4133a75430b013a7a1328560377 lt id gt lt catalogItem gt lt catalog gt lt id gt 90d965c0379fd06601379fd193620f05 lt id gt lt catalog gt lt catalogItem gt lt approvalProcess gt lt ApprovalProcessList gt The following XML was returned in the response The count value indicates the number of approval requests successfully deleted An ApprovalProcess element is included for each deleted approval request lt ApprovalProcessList gt lt count gt 2 lt count gt lt li
51. ApprovalRequired gt 0 lt minApprovalRequired gt lt approvalType gt lt id gt 90d96588360da0c701360da0f0b40094 lt id gt lt objectId gt 90d96588360da0c701360da0f0b40094 lt objectId gt lt createdOn gt 2013 02 25117 32 55 620 08 00 lt createdOn gt lt isCriticalSystemobject gt true lt isCriticalSystemobject gt lt description gt User Context Template lt description gt lt iconUr1 gt csa images categories approval_type user_context_template png lt iconUr1 gt lt name gt USER_CONTEXT_TEMPLATE lt name gt lt displayName gt User Context Template lt displayName gt lt disabled gt false lt disabled gt lt categoryType gt lt id gt 90d96588360da0c701360da0f0ac0092 lt id gt lt objectId gt 90d96588360da0c701360da0f0ac0092 lt objectId gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt name gt APPROVAL_TYPE lt name gt lt displayName gt Approval Type lt displayName gt lt extensible gt false lt extensible gt lt categoryType gt lt approvalType gt lt approvalLevel gt 1 lt approvalLevel gt lt UserContextApprovalTemplate gt lt NamedApproverApprovalTemplate gt lt NamedApproverApprovalTemplate gt lt NamedApproverApprovalTemplate gt lt NamedApproverApprovalTemplate gt lt ApprovalPolicyList gt HP Cloud Service Automation 4 10 Page 106 of 150 API Reference Create approval policy Details URI organization lt organization_id gt approvalPolicy Method POST Paramet
52. Artifact ID This is the artifact for which this process instance executes The following was sent to create a process instance https lt host gt lt port gt csa rest processinstances userIdentifier 90d9652b35F35a93 0135f35b327e00a0 The following XML was sent in the request lt ProcessInstance gt gt lt property gt lt isCriticalSystemObject gt false lt isCriticalSystemObject gt lt name gt Unit Test Process Instance Property lt name gt lt paramRoleType gt lt isCriticalSystemObject gt false lt isCriticalSystemObject gt lt name gt INPUT lt name gt lt disabled gt false lt disabled gt HP Cloud Service Automation 4 10 Page 121 of 150 API Reference lt paramRoleType gt lt valueType gt lt isCriticalSystemObject gt false lt isCriticalSystemObject gt lt name gt STRING lt name gt lt disabled gt false lt disabled gt lt valueType gt lt values gt lt value gt Unit Test Process Instance Property Value lt value gt lt values gt lt maxOccurs gt lt maxOccurs gt lt minOccurs gt lt minOccurs gt lt orderIndex gt 0 lt orderIndex gt lt confidential gt false lt confidential gt lt encrypted gt false lt encrypted gt lt readOnly gt false lt readOnly gt lt property gt lt processDefinition gt lt id gt 90d9652b35f41cbc0135f41cf1310004 lt id gt lt name gt Unit Test Process Definition 1 lt name gt lt processDefinition gt lt processInstanceState gt lt isCriticalSyst
53. 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 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 Valid license from HP required for possession use or copying Consistent with FAR 12 211 and 12 212 Commercial Computer Software Computer Software Documentation and Technical Data for Commercial Items are licensed to the U S Government under vendor s standard commercial license Copyright Notice O Copyright 2010 2014 Hewlett Packard Development Company L P Trademark Notices Adobe is a trademark of Adobe Systems Incorporated Microsoft and Windows are U S registered trademarks of Microsoft Corporation Oracle and Java are registered trademarks of Oracle and or its affiliates RED HAT READY Logo and RED HAT CERTIFIED PARTNER Logo are trademarks of Red Hat Inc This product includes an interface of the zlib general purpose compression library which is Copyright 1995 2002 Jean l
54. ICE_NAME lt name gt lt values gt lt value gt SERVICE_NAME request BE lt value gt lt values gt lt property gt lt property gt lt name gt SERVICE_DESCRIPTION lt name gt lt values gt lt value gt service_desc request BE lt value gt lt values gt lt property gt lt property gt lt name gt OPTION MODEL lt name gt lt values gt lt optionModel gt lt name gt SD2 lt name gt lt optionSets gt lt name gt 42FBA7E6 17EF 7B1A C4DD 0A5CB0246E55 lt name gt lt options gt lt name gt D914556A 6F6A 1BE0 035E 0A5CB021BE9B lt name gt lt property gt lt name gt INT lt name gt lt values gt HP Cloud Service Automation 4 10 Page 59 of 150 API Reference lt value gt 33 lt value gt lt values gt lt property gt lt property gt lt name gt BOOLEAN lt name gt lt values gt lt value gt true lt value gt lt values gt lt property gt lt property gt lt name gt STR lt name gt lt values gt lt value gt YY lt value gt lt values gt lt property gt lt options gt lt optionSets gt lt optionSets gt lt name gt D6A80E16 2977 4111 14B9 0A5E5D5B2F56 lt name gt lt options gt lt name gt 18CA9979 7C9D F5AC 06B5 0A5E5D5B3B51 lt name gt lt options gt lt optionSets gt lt optionModel gt lt values gt lt property gt lt requestedAction gt lt ServiceRequest gt The following XML was returned in the response lt ServiceRequest gt lt id gt 8a81818
55. Identifier lt user_id gt Required the user ID you want to use as credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier value view lt view_type gt 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 Note that artifact_id is the ID of any artifact that has an accesspoint https lt host gt port csa rest artifact fastview 90e72e4f3abe4bf4013ac24735730010 userIdentifier lt user_id gt amp view accesspoint The following XML was returned in the response lt xml version 1 0 encoding UTF 8 standalone yes gt lt resultView gt lt resultMap gt lt entry gt lt key gt accessPoint uri lt key gt lt value xsi type xs string gt http amz 443 lt value gt lt entry gt lt entry gt lt key gt accessPoint password lt key gt lt value xsi type xs string gt amz lt value gt lt entry gt lt entry gt lt key gt accessPoint username lt key gt lt value xsi type xs string gt amz lt value gt lt entry gt lt entry gt lt key gt accessPoint category name lt key gt lt value xsi type xs string gt URL lt value gt lt entry gt lt resultMap gt lt resultView gt HP Cloud Service Automation 4 10 Page 18 of 150 API Reference Filtering You can filter the results by providing a value for a property in the URI Th
56. Not found 500 Server exception HP Cloud Service Automation 4 10 Page 119 of 150 API Reference The following was sent to retrieve a process instance https lt host gt lt port gt csa rest processinstances 90d9652b3752ad4f013752ae38cb0065 The following XML was sent in the response lt ProcessInstance gt gt lt property gt lt isCriticalSystemObject gt false lt isCriticalSystemObject gt lt name gt Unit Test Process Instance Property lt name gt lt paramRoleType gt lt isCriticalSystemObject gt false lt isCriticalSystemObject gt lt name gt INPUT lt name gt lt disabled gt false lt disabled gt lt paramRoleType gt lt valueType gt lt isCriticalSystemObject gt false lt isCriticalSystemObject gt lt name gt INPUT lt name gt lt disabled gt false lt disabled gt lt valueType gt lt values gt lt value gt Unit Test Process Instance Property Value lt value gt lt values gt lt maxOccurs gt lt maxOccurs gt lt minOccurs gt lt minOccurs gt lt orderIndex gt lt orderIndex gt lt confidential gt false lt confidential gt lt encrypted gt false lt encrypted gt lt readOnly gt false lt readOnly gt lt property gt lt processDefinition gt lt id gt 90d9652b35f41cbc0135f41cf1310004 lt id gt lt name gt Unit Test Process Definition 1 lt name gt lt processDefinition gt lt processInstanceState gt lt isCriticalSystemObject gt false lt isCriticalSystemObject gt lt name gt INITI
57. 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 For the property attribute of an artifact the items of this collection attribute are matched by name For all other attributes the collection items are matched by id Examples The following examples demonstrate how to update an artifact HP Cloud Service Automation 4 10 Page 15 of 150 API Reference This example shows how to change the finalize flag of a component using the view parameter The following URL was sent https lt host gt lt port gt csa rest artifact 90e72e4f3af5c989013afb471ebc0264 userIde ntifier 8scope view8view componentfinalize The following XML was sent in the request body lt ServiceComponent gt lt id gt 90e72e4f3af5c989013afb471ebc0264 lt id gt lt toFinalize gt false lt toFinalize gt lt ServiceComponent gt This example shows changing the display name of a resource provider This example does not use the view parameters To use this approach retrieve the artifact using GET artifact API modify the necessary value in this example displayName and use that as the body of the PUT request to update the artifact The following URL was sent https lt host gt lt port gt csa rest artifact 90e72e4f3b00a69e013b0c0492b00033 userIde ntifier lt user_
58. Organization gt List organization s approval policies Details URI organization lt organization_id gt approvalPolicy Method GET Parameters userIdentifier lt user_id gt Required the user ID you want to use as credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier value Returns 200 Ok 401 Not authorized 404 Object not found 500 Server exception Example The following URL was sent https lt host gt lt port gt csa rest organization 8a81818f3d1421e7013d1423635a0003 approvalPolicy userIdentifier 90d96588360da0c701360da0f1d5f483 The following XML was returned lt xml version 1 0 encoding UTF 8 standalone yes gt lt ApprovalPolicyList gt lt UserContextApprovalTemplate gt HP Cloud Service Automation 4 10 Page 105 of 150 API Reference lt id gt 8a81818f3d1421e7013d1423646e0008 lt id gt lt objectId gt 8a81818F3d1421e7013d1423646e0008 lt objectId gt lt createdOn gt 2013 02 25117 34 56 623 08 00 lt createdOn gt lt updatedOn gt 2013 02 25T17 34 56 627 08 00 lt updatedOn gt lt name gt USER CONTEXT APPROVAL TEMPLATE QA ORG 1 lt name gt lt displayName gt QA Org 1 User Context Approval Template lt displayName gt lt state gt lt state gt lt artifactType gt lt artifactType gt lt automaticApproval gt false lt automaticApproval gt lt automaticPeriodDuration gt lt automaticPeriodDuration gt lt min
59. RING RESOURCE ENVIRONMENT Optional if specified content archive is verified to be of the specified type 200 Updated 400 Bad request 404 Not found 500 Server exception Caution Component palette import is an update operation and so associateProviders and HP Cloud Service Automation 4 10 Page 83 of 150 API Reference updatePreserveExisting parameters will be ignored The following headers must be set when using this API to upload the content archive e Content type multipart form data e Content Disposition form data name file e Content Type application octet stream Example The following URL was sent https localhost 8444 csa rest importzip userIdentifier 90d96588360da0c701360da0f1d5f4838file SERVICE DESIGN Simple Compute Linux_90cec2023cc75f8a013cc7643ad00034 zip The following XML was returned lt xml version 1 0 encoding UTF 8 standalone yes gt lt importMessageList gt lt messages gt Service design Simple Compute Linux imported successfully Id 90cec2ff3dd11298013dd1139eb7004f lt messages gt lt messages gt Resource offering SA Offering imported successfully Id 90cec2ff3dd11298013dd113992de00d lt messages gt lt messages gt Resource offering uCMDB Offering imported successfully Id 90cec2ff3dd11298013dd113977d0008 lt messages gt lt messages gt Resource offering vCenter Offering imported successfully Id 90cec2ff3dd11298013dd113924f0016 lt messages gt lt impor
60. alSystem0bject gt HP Cloud Service Automation 4 10 Page 51 of 150 API Reference lt name gt EXAMPLE_SECOND_CATEGORY lt name gt lt displayName gt Example second category lt displayName gt lt disabled gt false lt disabled gt lt catalogCategory gt lt catalogCategory gt lt catalogCategory gt lt catalogCategory gt lt id gt 8a81818f3d128500013d1341a5c6000d lt id gt lt isCriticalSystemObject gt false lt isCriticalSystem0bject gt lt description gt description for catalog category lt description gt lt iconUr1 gt catalog category x png lt iconUr1 gt lt name gt EXAMPLE_FIRST_CATALOG_CATEGORY lt name gt lt displayName gt Example first Catalog Category lt displayName gt lt disabled gt false lt disabled gt lt catalogCategory gt lt catalogCategory gt lt catalogCategory gt e Catalogs Update catalog categories Details URI catalog lt catalog_id gt category lt category_id gt Method PUT Parameters userIdentifier lt user_id gt Required the user ID you want to use as credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier value Returns 200 Ok Indicates the REST call executed without error See XML return content for details on categories updated 401 Not authorized 404 Object not found 500 Server exception Note that any CatalogCategory elements not specified in the request body will be left unchanged Exa
61. ally including tokens token 9 Token1 1 lt contentBody gt lt Each recipient must have an id and type Only PERSON and ORGANIZATION a re valid types Notifications will be sent to valid recipients and an error mess age returned for the invalid ones Response code 200 OK will be returned if ther e is at least one valid recipient gt lt recipient gt lt id gt UUID of the recipient lt id gt lt type gt PERSON lt type gt lt recipient gt lt recipient gt lt id gt UUID of organization lt id gt lt type gt ORGANIZATION lt type gt lt recipient gt lt tokens must be specified if your contentBody contains tokens No token validation is done gt lt tokens gt lt tokenSequence gt lt tokenSequence gt lt value gt Token content lt value gt lt tokens gt lt tokens gt lt tokenSequence gt 1 lt tokenSequence gt lt value gt Token 1 content lt value gt lt tokens gt lt Notification gt Examples The following URL was sent HP Cloud Service Automation 4 10 Page 96 of 150 API Reference https lt host gt lt port gt csa rest notification party userIdentifier 90cec32a03a93ef8 9013a93f07b880001 The following XML was sent in the request note that the second recipient id is bad lt xml version 1 0 encoding UTF 8 standalone yes gt lt Notification gt lt subject gt Test Subject lt subject gt lt contentBody gt Test content body token0o 0 Token1 1 lt co
62. alse lt disabled gt lt categoryType gt lt id gt 90d96588364da0c701370da0ss320030 lt id gt lt objectId gt 90d96588364da0c701370da0ss320030 lt objectId gt lt isCriticalSystemObject gt true lt isCriticalSystem0bject gt lt name gt ARTIFACT_TYPE lt name gt lt displayName gt Artifact Type lt displayName gt lt extensible gt false lt extensible gt lt categoryType gt lt artifactType gt lt disabled gt false lt disabled gt lt catalog gt lt catalog gt HP Cloud Service Automation 4 10 Page 48 of 150 API Reference lt catalog gt lt CatalogList gt Get catalog details Details URI Method Parameters Returns Examples catalog lt catalog_id gt Use List catalogs on page 47 to get the catalog ID GET userIdentifier lt user_id gt 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 userldentifier on page 91 for the steps required to get the userldentifier value scope base baseplusone subtree 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 If value is subtree then the object and all of its descendants are returned detail required basic standard template full Optional default is full See Values for the detail parameter on page
63. an artifact Details URI artifact lt artifact_id gt Method DELETE Parameters userIdentifier lt user_id gt Required the user ID you want to use as credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier value Returns 200 Ok 401 Not authorized 500 Server exception 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 44 for retiring consumption artifacts Artifact type Details Resource Can only be deleted if no active service subscriptions use the resource provider provider Service design Can be deleted when all associated service offerings or service instances are retired Retrieve a predefined view for an artifact Because the REST API presented here returns content in a different format when retrieving a single result versus multiple results and could thereby complicate your using the results it is recommended that the View an artifact on page 12 API be used Performance intensive applications might still choose to use the following API HP Cloud Service Automation 4 10 Page 17 of 150 API Reference Details URI artifact fastview lt artifact_id gt Method GET Parameters user
64. and time Time will default to 00 00 00 if not specified Date and time are assumed to be in the time zone of the CSA server creationEndDate lt yyyy MM ddTHH mm ss gt Optional approval requests created before end date and time will be included in the return T serves as a separator between data and time Time will default to 00 00 00 if not specified Date and time are assumed to be in the time zone of the CSA server Caution The users specified by userIdentifier and approver must be in the same organization 200 Ok 401 Not authorized 500 Server exception HP Cloud Service Automation 4 10 Page 136 of 150 API Reference Get count of approvals for user Details URI Method Parameters Returns user approval count Gets the number of approvals for the user associated with userldentifier The results are grouped by approval result state GET userIdentifier lt user_id gt 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 userldentifier on page 91 for the steps required to get the userldentifier value 200 Ok 401 Not authorized 500 Server exception Delete multiple approval requests Details URI Method Parameters Returns user multipleApprovals delete POST userIdentifier lt user_id gt Required the user ID you want to use as credentials for this
65. anged e Once a subscription request has been approved the request can no longer be canceled The subscription though can be canceled Example Use the following URL https lt host gt lt port gt csa rest user multipleRequest cancel userIdentifier 90d965c0379fd06601379fd192b30ee6 The following XML was sent in the request lt ServiceRequestList gt lt ServiceRequest gt lt id gt 90e72e283b05aff1013b0b2c015103234 lt id gt lt catalogItem gt lt catalog gt lt id gt 90d965c 379Fd06601379Fd1936a0FO5 lt id gt HP Cloud Service Automation 4 10 Page 133 of 150 API Reference lt catalog gt lt catalogItem gt lt ServiceRequest gt lt ServiceRequest gt lt id gt 90e72e283b05aff1013b0b2b43fc0356 lt id gt lt catalogItem gt lt catalog gt lt id gt 90d965c0379fd06601379fd193620f05 lt id gt lt catalog gt lt catalogItem gt lt ServiceRequest gt lt ServiceRequestList gt The following XML was returned in the response The count value indicates the number of service requests successfully canceled A ServiceRequest element is included for each canceled service request lt ServiceRequestList gt lt count gt 2 lt count gt lt limit gt lt limit gt lt ServiceRequest gt lt id gt 90e72e283b05aff1013b0b2c015103234 lt id gt lt ServiceRequest gt lt ServiceRequest gt lt id gt 90e72e283b05aff1013b0b2b43fc0356 lt id gt lt ServiceRequest gt lt ServiceRequestList gt Dele
66. ase baseplusone subtree 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 If value is subtree then the object and all of its descendants are retumed detail required basic standard template full Optional default is full See Values for the detail parameter on page 147 Some API calls do not support all possible values for this parameter HP Cloud Service Automation 4 10 Page 72 of 150 API Reference URI catalog lt catalog_id gt subscription lt subscription_id gt 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 Returns 200 Ok 401 Not authorized 404 Not found 500 Server exception Examples The following URL was sent https lt host gt lt port gt csa rest catalog 402895e33732af18013732b6f435006b subscription 90d957ea3806fa7e013807acc79000b3 userIdentifier 90d9652b67ss6a930135f35b327e00a0 The following XML was returned lt xml version 1 0 encoding UTF 8 standalone yes gt lt ServiceSubscription gt lt id gt 90d957ea3806fa7e013807acc79000b3 lt id gt lt name gt MY SR lt name gt lt displayName gt MY SR lt displayName gt lt optionModel gt lt optionModel gt lt serviceInstance gt lt serviceInstance gt lt serviceOffering gt lt serviceOffering gt lt subscriptionStatus gt
67. ateProvider candidatePool name resourceBinding candidateProvider candidatePool displayNa me resourceBinding candidateProvider candidatePool disabled resourceBinding candidateProvider candidatePool useProvid erEnv resourceBinding candidateProvider resourceProvider id resourceBinding candidateProvider resourceProvider objectld resourceBinding candidateProvider resourceProvider isCritica ISystemObject resourceBinding candidateProvider resourceProvider name resourceBinding candidateProvider resourceProvider display Name resourceBinding candidateProvider resourceProvider disabled HP Cloud Service Automation 4 10 Description Retrieves the required properties from an artifact object in addition to all the basicinfo properties Retrieves information from any Identity object All artifacts and some additional entities e g accessPoint are identity objects Use this view to retrieve candidate resource provider pools for a given resource binding Use this view to retrieve candidate resource providers for a given resource binding Page 38 of 150 API Reference View name componentchild componentfinali ze componentlifec ycle componentroot Properties componentChild name componentC hild display Name componentC hild description componentChild iconUrl componentChild detailedDescription componentChild isCriticalSystemObject componentChild ownedBy name componentChild state nam
68. aticPeriodDuration gt lt automaticApprovalDecision gt lt name gt REJECTED lt name gt lt automaticApprovalDecision gt lt NamedApproverApprovalTemplate gt In NamedGroupApprovalTemplate request body HP Cloud Service Automation 4 10 Page 107 of 150 API Reference e displayName is required e group s distinguishedName is required e minApprovalRequired is optional and defaults 1 Value cannot be greater than the number of users in the group e automaticApproval is optional if not present defaults to false If automaticApproval is true a automaticPeriodDuration in days is optional if not present defaults to O Valid value is integer from 0 to 365 a automaticApprovalDecision is required valid value is APPROVED or REJECTED Example request body lt NamedGroupApprovalTemplate gt lt displayName gt Name Group Template 01 lt displayName gt lt group gt lt distinguishedName gt cn ServiceConsumer ou ConsumerGroup ou CSAGroups lt distinguishedName gt lt group gt lt minApprovalRequired gt lt minApprovalRequired gt lt automaticApproval gt true lt automaticApproval gt lt automaticApprovalDecision gt lt automaticApprovalDecision gt lt name gt REJECTED lt name gt lt automaticApprovalDecision gt lt NamedGroupApprovalTemplate gt In UserContextApprovalTemplate request body e displayName is required e automaticApproval is optional if not present defaults to false If automaticApprova
69. authorized 404 Not found 500 Server exception Example The following URL was sent https localhost 8444 csa rest catalog 8a8181853810699a0138106dcebc e011 request 8a8181853810699a01381079190800a7 userTdentifier 8a8181853810699a01381076be5499a0 The following XML was returned lt ServiceRequest gt lt id gt 8a8181853810699a01381079190800a7 lt id gt lt objectId gt 8a8181853810699a01381979190800a7 lt objectlId gt lt createdOn gt 2012 06 21712 16 08 073 07 00 lt createdOn gt lt updatedOn gt 2012 06 21T12 16 50 787 07 00 lt updatedOn gt lt createdBy gt lt id gt 8a8181853810699a01381076be5400a0 lt id gt lt objectId gt 8a8181853810699a01381076be5400a0 lt objectId gt lt isCriticalSystemObject gt false lt isCriticalSystemObject gt lt name gt consumer1 lt name gt lt disabled gt false lt disabled gt lt createdBy gt lt updatedBy gt lt id gt 90d96588360da0c701360da0f1d5f483 lt id gt lt objectId gt 90d96588360da0c701360da0f1d5f483 lt objectId gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt name gt admin lt name gt HP Cloud Service Automation 4 10 Page 61 of 150 API Reference lt di lt di splayName gt admin lt displayName gt sabled gt false lt disabled gt lt updatedBy gt lt isCriticalSystemObject gt false lt isCriticalSystem0bject gt lt descr lt detai lt iconU lt name gt lt displ lt catal lt id lt cr lt up lt cr lt C lt
70. be540090 The following XML was returned lt Organization gt lt id gt 8a8181853810699a0138106dcddeeee3 lt id gt lt objectId gt 8a818185381069920138106dcdd00803 lt objectId gt lt createdOn gt 2012 06 21712 03 47 920 07 00 lt createdOn gt lt updatedOn gt 2012 06 21712 04 10 597 07 00 lt updatedOn gt lt isCriticalSystemobject gt false lt isCriticalSystemobject gt lt description gt desc CSA organization lt description gt lt iconUr1 gt csa images library Earth_48 png lt iconUr1 gt lt name gt CSA lt name gt lt displayName gt CSA lt displayName gt lt state gt lt id gt 90d96588360da0c701360da0ef470038 lt id gt lt objectId gt 90d96588360da0c701360da0ef470038 lt objectId gt lt createdOn gt 2012 06 21711 51 43 267 07 00 lt createdOn gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt description gt Active lt description gt lt iconUrl gt csa images categories artifact state active png lt iconUrl gt lt name gt ACTIVE lt name gt lt displayName gt Active lt displayName gt lt disabled gt false lt disabled gt HP Cloud Service Automation 4 10 Page 103 of 150 API Reference lt categoryType gt lt id gt 90d96588360da0c701360da0ef420037 lt id gt lt objectId gt 90d96588360da0c701360da0ef420037 lt objectId gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt name gt ARTIFACT_STATE lt name gt lt displayName gt Artifact State lt displayName gt l
71. c701360da0f1d5f483 lt objectId gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt name gt admin lt name gt lt displayName gt admin lt displayName gt lt disabled gt false lt disabled gt lt updatedBy gt lt isCriticalSystemObject gt false lt isCriticalSystemObject gt lt description gt TestEnv lt description gt lt name gt TestEnv_November 17 2012 1 24 55 AM UTC lt name gt lt displayName gt TestEnv lt displayName gt lt state gt lt id gt 90d96588360da0c701360da0ef470038 lt id gt lt objectId gt 90d96588360da0c701360da0ef470038 lt objectId gt lt createdOn gt 2012 11 01T15 16 54 687 07 00 lt createdOn gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt description gt Active lt description gt lt iconUr1 gt csa images categories artifact_state active png lt iconUr1 gt lt name gt ACTIVE lt name gt lt displayName gt Active lt displayName gt lt disabled gt false lt disabled gt lt categoryType gt lt id gt 90d96588360da0c701360da0ef420037 lt id gt lt objectId gt 90d96588360da0c701360da0ef420037 lt objectId gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt name gt ARTIFACT_STATE lt name gt HP Cloud Service Automation 4 10 Page 13 of 150 API Reference lt displayName gt Artifact State lt displayName gt lt extensible gt false lt extensible gt lt categoryType gt lt state gt lt artifactType gt lt id gt 90d96588360da0c
72. categoryType gt lt artifactContextType gt lt category gt lt name gt AABBCCDD lt name gt lt displayName gt AABBCCDD lt displayName gt lt categoryType gt lt name gt CATALOG_CATEGORY lt name gt lt categoryType gt lt category gt lt catalogItem gt lt CatalogItems gt The following XML was returned in the response lt xml version 1 0 encoding UTF 8 standalone yes gt lt messageList gt lt messages gt Publish OFFERING1_January 30 2013 6 18 47 PM UTC to category AABBC CDD failed Category doesn t exist lt messages gt lt messages gt Publish OFFERING2_January 28 2013 11 32 17 PM UTC to category ACCE SSORY succeeded lt messages gt lt messages gt Publish OFFERING1_January 30 2013 6 18 47 PM UTC to category CRM s ucceeded lt messages gt lt messageList gt Unpublish service offerings from catalog Details URI artifact lt catlog id gt unpublish Method POST Parameters userIdentifier lt user_id gt Required the user ID you want to use as credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier value Returns 200 Ok 401 Not authorized 404 Object not found 500 Server exception Example The following URL was sent HP Cloud Service Automation 4 10 Page 33 of 150 API Reference https lt host gt lt port gt csa rest artifact 90e72e323b5330cc013b5358c0948021 unpubli sh userIdentifier 90d96588360da0c701360
73. ccecccceees 129 List active requests for user 0 000 000 130 Get count of requests for user 22 2 022222 c cece eee nr 132 Cancel multiple service requests 0000 cece cece cece cccccceeeeeeeeeees 133 Delete multiple service requests 000000 0000 134 List approvals for approver 00 000000 0002 136 Get count of approvals foruser eee ee ccc eee eee nennu 137 Delete multiple approval requests 0 0000 0000 0 137 List subscriptions for user 00 000 0000 138 Get count of subscriptions for user 00000 cece ccceeeecccccccceeees 140 Get list of recent or expiring soon subscriptions for user 0 2222 141 Delete multiple subscriptions 2 2 0 0 ccc cece ccc cece cece cece cceeeeecceeeees 141 List instances for USES occ 143 HP Cloud Service Automation 4 10 Page 6 of 150 API Reference Contents Chapter 16 Utilization API 145 Chapter 17 Values for the detail parameter 147 Chapter 18 Values for the scope parameter 00000000 00 0 148 We appreciate your feedback cece ccc eccecceceeceeceecereeees 149 HP Cloud Service Automation 4 10 Page 7 of 150 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 fo
74. ce 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 As part of this retrieval relevant tokens configured on properties are also resolved HP Cloud Service Automation 4 10 Page 19 of 150 API Reference There are two approaches to retrieving resolved properties e Retrieve all properties e Retrieve a single named property Details URI Method artifact lt artifact_id gt resolveProperties GET Parameters userIdentifier lt user_id gt Required the user ID you want to use as credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier value propertyName lt property_name gt Optional the name of the property you want to retrieve Only retrieves the value for the property specified Returns 200 Ok 401 Not authorized 404 Not found 500 Server exception Examples The following URL was used to retrieve all properties for an artifact https lt host gt lt port gt csa rest artifact lt id gt resolveProperties userIdentifier lt u ser_id gt The following XML was returned in the response lt xml ve lt Propert lt pro lt pro lt pro rsion 1 0 encoding UTF 8 standalone yes gt ies gt perty gt lt property gt perty gt lt property gt perty gt lt id gt 90d9651a3684c
75. ce gt lt id gt 90d957ea3806fa7e01380f957d11070a lt id gt lt name gt MYSD_June 5 2012 5 19 51 PM UTC lt name gt lt displayName gt MYSD lt displayName gt lt state gt lt state gt lt serviceInstanceState gt lt serviceInstanceState gt lt ServiceInstance gt lt ServiceInstancelist gt HP Cloud Service Automation 4 10 Page 144 of 150 Chapter 16 Utilization API Description Use this API to retrieve a list of resource utilization objects for the specified subscription Base URL https lt host gt lt port gt csa rest Details URI utilization lt subscription_id gt See List subscriptions for user for information on obtaining subscription IDs Method GET Parameters userIdentifier lt user_id gt Required the user ID you want to use as credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier value Returns 200 Updated 404 Not found 500 Server exception Example use context An organization s policy is to do resource provider selection based on available capacity for all providers The information returned by this API can be used to determine what resources are already in use Example The following URL was sent https lt host gt lt port gt csa rest utilization 9 cec3a032667c69013a6d7f0eea2cb3 The following XML was returned in the response lt xml version 1 0 encoding UTF 8 standalone yes gt lt UtilizationList
76. cleengine lt lifecycle action id gt Method GET Parameters userldentifier lt user id gt Required the user ID you want to use as credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier value Returns 200 Ok 401 Not authorized 404 Not found 500 Server exception Examples Use the following URL HP Cloud Service Automation 4 10 Page 87 of 150 API Reference https lt host gt lt port gt csa rest lifecycleengine 90d96588360da0c701360da0f25400c2 userIdentifier 90596588670da0c701360da0f1d540a1 The following XML was returned in the response lt xml version 1 0 encoding UTF 8 standalone yes gt lt LifecycleExecutionRecord gt lt callbackPending gt false lt callbackPending gt lt executionState gt lt id gt 90d96588360da0c701360da0f25400c2 lt id gt lt objectId gt 90d96588360da0c701360da0f25400c2 lt objectId gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt name gt READY lt name gt lt disabled gt false lt disabled gt lt categoryType gt lt id gt 90d96588360da0c701360da0F25200c1 lt id gt lt objectId gt 90d96588360da0c701360da0F25200c1 lt objectId gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt name gt LIFECYCLE_EXECUTION_STATE lt name gt lt extensible gt false lt extensible gt lt categoryType gt lt executionState gt lt reverse gt false lt reverse gt lt serviceInstance
77. credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier value Returns 200 Ok 401 Bad request 404 Not found 500 Server exception Note that the directory the archive will be downloaded to is defined by the REST client or browser in use Artifact archives are structured as following e Resource environment archive contains Resource environment XML Manifest XML e Resource offering archive contains Resource offering XML Icons used for customizing resource offering a Manifest XML e Service design archive contains Service design XML Resource offering XMLs Icons used for customizing resource offerings and service design Dynamic option JSP files Manifest XML HP Cloud Service Automation 4 10 Page 77 of 150 API Reference e Service offing archive contains Service offering XML Service design XML Resource offering XMLs Icons used for customizing service offering service design and resource offerings Dynamic option JSP files Manifest XML e Catalog archive contains Catalog XML Service offering XMLs Service design XMLs Resource offering XMLs Resource environment XMLs Icons used for customizing catalog service offerings service designs and resource offerings Dynamic option JSP files Manifest XML e Component palette archive contains Component palette XML Service component type XMLs Service component template XMLs Reso
78. cription Get userldentifier below Get userldentifier for user name with slash on the next page See orglnformation API on page 117 for getting an organzation s credentials Get userldentifier Details URI login lt organization_name gt lt user_name gt Where lt organization_name gt and lt user_name gt are your credentials for logging in to HP Cloud Service Automation Method GET Returns 200 Ok 401 Not authorized 500 Server exception Note Unlike most API calls the arguments organization name and user name are part of the URL path rather than parameters Caution If the trailing slash is not included a portion of the user name might be truncated HP Cloud Service Automation 4 10 Page 91 of 150 API Reference when the user name includes non alphanumeric characters A best practice is to always include a trailing slash Example To get the userldentifier we used the following URL https lt host gt lt port gt csa rest login MyOrganization admin The following XML was returned in the response lt xml version 1 0 encoding UTF 8 standalone yes gt lt person gt lt id gt 90s96588670da0c701360da0f1d540a1 lt id gt lt This is userIdentifier gt lt Remaining XML is not relevant for this example gt lt person gt The value for userIdentifier is the first lt id gt value returned in the XML Get userldentifier for user name with slash Details URI login
79. d access to the catalog but no longer have access HP Cloud Service Automation 4 10 Page 56 of 150 API Reference Details URI Method Parameters Returns Examples catalog lt catalog id gt request Use List catalogs on page 47 to get the catalog ID GET userIdentifier lt user_id gt 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 userldentifier on page 91 for the steps required to get the userldentifier value scope base view Optional default is base detail basic Optional The only valid value is basic submitter lt user_name gt Required user name must be valid and must be authorized to view the request returnRetired true false Optional default is false 200 Ok 401 Not authorized 500 Server exception The following URL was sent https localhost 8444 csa rest catalog 8a818185381069920138106dcebce011 reques t userTdentifier 8a8181853810699201381076be540020 The following XML was returned in the response lt ServiceRequestList gt lt count gt 21 lt count gt lt limit gt 0 lt limit gt lt ServiceRequest gt lt id gt 8a8181853810699a01381079190800a7 lt id gt lt objectId gt 8a8181853810699201381079190800a7 lt objectId gt lt createdOn gt 2012 06 21T12 16 08 073 07 00 lt createdOn gt lt updatedOn gt 2012 06 21T12 16 50 787 07
80. da0f1d5f483 The following XML was sent in the request lt Catalogltems gt lt catalogItem gt lt artifactContext gt lt name gt OFFERING1_January 30 2013 6 18 47 PM UTC lt name gt lt artifactContext gt lt artifactContextType gt lt name gt SERVICE_OFFERING lt name gt lt categoryType gt lt name gt ARTIFACT_TYPE lt name gt lt categoryType gt lt artifactContextType gt lt category gt lt name gt CRM lt name gt lt categoryType gt lt name gt CATALOG_CATEGORY lt name gt lt categoryType gt lt category gt lt catalogltem gt lt catalogltem gt lt artifactContext gt lt name gt OFFERING2 January 28 2013 11 32 17 PM UTC lt name gt lt artifactContext gt lt artifactContextType gt lt name gt SERVICE_OFFERING lt name gt lt categoryType gt lt name gt ARTIFACT_TYPE lt name gt lt categoryType gt lt artifactContextType gt lt category gt lt name gt AABBCCDD lt name gt lt displayName gt AABBCCDD lt displayName gt lt categoryType gt lt name gt CATALOG_CATEGORY lt name gt lt categoryType gt lt category gt lt catalogltem gt lt CatalogItems gt The following XML was returned in the response lt xml version 1 0 encoding UTF 8 standalone yes gt lt messageList gt lt messages gt Unpublish Service Offering OFFERINGI January 30 2013 6 18 47 PM UT C from category CRM succeeded lt messages gt lt messages gt Unpublish Service Offering OFFERING2_January 28 201
81. default is false If true any existing artifacts of the same type with the same name will be preserved not overwritten and renamed Existing references to these artifacts will automatically use the renamed artifacts New artifacts are created from the archive Cannot be used with update parameter Caution Produces same results as updatePreserveE xisting Allows for backward compatibility update true false Optional default is false If true any existing artifacts of the same type and with the same name will be overwritten otherwise the artifacts are created Cannot be used with updatePreserveExisting parameter updatePreserveExisting true false Optional default is false If true any existing artifacts of the same type with the same name will be preserved not overwritten and renamed Existing references to these artifacts will automatically use the renamed artifacts New artifacts are created from the archive Cannot be used with update parameter orgForCatalogImport lt organization_name gt Required for import of catalog archive the name of the organization to be used when creating the imported catalog associateProviders true false Optional default is false If true resource providers in the archive are bound to existing resource offerings and resource environments of the same provider type and display name in the database validateType COMPONENT PALETTE CATALOG SERVICE_OFFERING SERVICE DESIGN RESOURCE_OFFE
82. default value is not accepted for organization artifacts because the volume of content returned can be excessively large Specify detail BASIC to avoid an exception message view lt view_type gt Required when value for scope is view if this parameter is defined then the value for scope is processed as if its value was view The default is basicinfo See Artifact views on page 36 for a list of view types 200 Ok 401 Not authorized 500 Server exception HP Cloud Service Automation 4 10 Page 12 of 150 API Reference Examples Use the following URL https lt host gt lt port gt csa rest artifact 90e72e4f3b00a69e013b0bf7ed55002e userIde ntifier lt user_id gt The following XML was returned in the response lt ResourceEnvironment gt lt id gt 90e72e4f3be0a69e013bebF7ed55002e lt id gt lt objectId gt 9 e72e4F3b00a69e01 3bObF7ed55002e lt objectId gt lt createdOn gt 2012 11 16717 24 55 765 08 00 lt createdOn gt lt updatedOn gt 2012 11 16T17 24 55 765 08 00 lt updatedOn gt lt createdBy gt lt id gt 90d96588360da0c701360da0f1d5f483 lt id gt lt objectId gt 90d96588360da0c701360da0f1d5f483 lt objectId gt lt isCriticalSystem0bject gt true lt isCriticalSystem0bject gt lt name gt admin lt name gt lt displayName gt admin lt displayName gt lt disabled gt false lt disabled gt lt createdBy gt lt updatedBy gt lt id gt 90d96588360da0c701360da0f1d5f483 lt id gt lt objectId gt 90d96588360da0
83. e componentC hild artifact Type name componentChild disabled componentChild servicelnstance id componentChild componentType name componentChild lifecycleProperties lifecycleState name componentChild lifecycleProperties lifecycleSubstate name componentChild id toFinalize lifecycleProperties lifecycleState name lifecycleProperties lifecycleSubstate name componentRoot name componentRoot displayN ame componentRoot description componentRoot iconUrl componentRoot detailedDescription componentRoot isCriticalSystemObject componentRoot ownedBy name componentRoot state name componentRoot artifactType name componentRoot disabled componentRoot servicelnstance id componentRoot componentType name componentRoot lifecycleProperties lifecycleState name componentRoot lifecycleProperties lifecycleSubstate name componentRoot id HP Cloud Service Automation 4 10 Description Use this view to add update service components from the parent service component Use this view to change the finalize flag fora component Use this view to change the lifecycle state and substate for a component Use this view to add a root service component to a ServiceBluep rint ora Servicelnsta nce object Page 39 of 150 API Reference View name Properties Description disabledesign ServiceBlueprint disabled Use this view to enable or disable a ServiceBluep rint propertyinfo property name Retrieves a property values valu
84. e following XML was sent in the request lt xml version 1 0 encoding UTF 8 standalone yes gt lt CatalogItems gt lt catalogltem gt lt artifactContext gt lt name gt OFFERING1I January 30 2013 6 18 47 PM UTC lt name gt lt artifactContext gt lt artifactContextType gt lt name gt SERVICE OFFERING lt name gt lt categorylype gt lt name gt ARTIFACT TYPE lt name gt lt categoryType gt lt artifactContextType gt lt category gt lt name gt CRM lt name gt lt categorylype gt lt name gt CATALOG CATEGORY lt name gt lt categoryType gt lt category gt lt catalogltem gt lt catalogltem gt lt artifactContext gt lt name gt OFFERING2 January 28 2013 11 32 17 PM UTC lt name gt lt artifactContext gt lt artifactContextType gt lt name gt SERVICE_OFFERING lt name gt lt categoryType gt lt name gt ARTIFACT_TYPE lt name gt lt categoryType gt lt artifactContextType gt lt category gt lt name gt ACCESSORY lt name gt lt categorylype gt lt name gt CATALOG CATEGORY lt name gt lt categoryType gt lt category gt lt catalogltem gt lt catalogItem gt lt artifactContext gt lt name gt OFFERING1_January 30 2013 6 18 47 PM UTC lt name gt lt artifactContext gt HP Cloud Service Automation 4 10 Page 32 of 150 API Reference lt artifactContextType gt lt name gt SERVICE_OFFERING lt name gt lt categoryType gt lt name gt ARTIFACT_TYPE lt name gt lt
85. e gt lt displayName gt Application Servers lt displayName gt lt disabled gt false lt disabled gt lt category gt lt catalogItem gt lt catalogItem gt lt catalogItem gt lt state gt lt isCriticalSystemObject gt false lt isCriticalSystemObject gt lt disabled gt false lt disabled gt lt state gt lt artifactType gt HP Cloud Service Automation 4 10 Page 115 of 150 API Reference lt id gt 90d96588360da0c701360da0eecb001b lt id gt lt isCriticalSystemObject gt false lt isCriticalSystemObject gt lt disabled gt false lt disabled gt lt artifactType gt lt disabled gt false lt disabled gt lt ServiceOffering gt lt ServiceOfferingList gt HP Cloud Service Automation 4 10 Page 116 of 150 Chapter 12 orginformation API Description Usethis API to get an organization s credentials Base URL https lt host gt lt port gt csa rest Details URI orgInformation lt organization name gt Method GET Returns 200 Ok 404 Not found 500 Server exception Example The following URL was sent https lt host gt lt port gt csa rest orgInformation my organization The following XML was returned in the response lt xml version 1 0 encoding UTF 8 standalone yes gt lt Organization gt lt isCriticalSystemObject gt false lt isCriticalSystem0bject gt lt description gt My Organization lt description gt lt name gt my_organization lt name gt lt disabled gt false lt
86. e list of all the property valueType name properties U property consumerVisible sed for property displayName creating new properties propertyvalue property name This view is property values value useful if the property consumerVisible need is only property displayName to update a property value resourceBinding isCriticalSystemObject Use this view resourcebinding resourceBinding state name to info resourceBinding artifactType name create updat resourceBinding disabled e aResource resourceBinding bindingState name Binding resourceBinding resourceOffering name resourceBinding lifeCycleProperties lifecycleState name resourceBinding lifeC ycleProperties lifecycleSubstate name resourceBinding resourceProvider name validproviders resourceBinding id Use this view resourceBinding validProvider resourceBinding id to retrieve or resourceBinding validProvider resourceProvider id to update valid resource providers for a given resource binding HP Cloud Service Automation 4 10 Page 40 of 150 API Reference View name validprovidersp ools Properties resourceBinding id resourceBinding validProvider resourceBinding id resourceBinding validProvider resourceProvider id resourceBinding validProvider validPool id Description Use this view to update valid resource providers and valid resource provider pools fora given resource binding For the candidatepools candidateproviders validproviders and valid
87. e 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 The following URL was sent https lt host gt lt port gt csa rest artifact fastview 90e72e4f3b00969e013b0c0492ab0003 userIdentifier lt user_id gt 8view propertyinfog8property_name propBLN The following XML was returned in the response lt xml version 1 0 encoding UTF 8 standalone yes gt lt resultView gt lt resultMap gt lt entry gt lt key gt property values value lt key gt lt value xsi type xs string gt true lt value gt lt entry gt lt entry gt lt key gt property consumerVisible lt key gt lt value xsi type xs boolean gt true lt value gt lt entry gt lt entry gt lt key gt property displayName lt key gt lt value xsi type xs string gt Boolean property lt value gt lt entry gt lt entry gt lt key gt property valueType name lt key gt lt value xsi type xs string gt BOOLEAN lt value gt lt entry gt lt entry gt lt key gt property name lt key gt lt value xsi type xs string gt propBLN lt value gt lt entry gt lt resultMap gt lt resultView gt Retrieve resolved properties for an artifact A property can have a sour
88. e subscription X X Service component X X X X Service blueprint X X X X Service instance X X Service offering X X X X Service request X Subscription X Create an artifact Details URI artifact Method POST HP Cloud Service Automation 4 10 Page 11 of 150 API Reference URI Parameters Returns artifact userIdentifier lt user_id gt Required the user ID you want to use as credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier value 200 Ok 401 Not authorized 404 Not found 500 Server exception View an artifact Details URI Method Parameters Returns artifact lt artifact_id gt GET userIdentifier lt user_id gt Required the user ID you want to use as credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier 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 If value is subtree then the object and all of its descendants are returned If the value is vie then the view parameter is required detail required basic standard template full Optional default is full See Values for the detail parameter on page 147 Note Some API calls do not support all possible values for this parameter detail FULL even as the
89. eated when a consumer requests a service offering and includes all of the options selected by the consumer when the subscription was initiated URI Method Parameters Description catalog lt catalog_ GET userldentifier scope List subscriptions in the id gt subscription detail requestor catalog on page 71 catalog lt catalog_ GET userldentifier scope Get subscription details id gt subscription lt subscription detail on page 72 id gt Resource Subscription URI Method Parameters Description catalog lt catalog_ GET userldentifier Get resource subscription id gt resourceSubscription scope detail details on page 76 Instance An instance is created when a request is approved and includes details about the requested services such as the status of services IP addresses etc HP Cloud Service Automation 4 10 Page 46 of 150 API Reference URI Method Parameters Description catalog lt catalog_id gt instance GET userldentifier scope List instances in the detail requestor catalog on page 74 catalog lt catalog_ GET userldentifier scope Get instance details on id gt instance lt instance_id gt detail page 75 List catalogs Details URI Method Parameters Returns Examples catalog GET userIdentifier lt user_id gt 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 S
90. ee Get userldentifier on page 91 for the steps required to get the userldentifier value scope base baseplusone subtree 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 If value is subtree then the object and all of its descendants are returned detail required basic standard template full Optional default is basic See Values for the detail parameter on page 147 Some API calls do not support all possible values for this parameter 200 Ok 401 Not authorized 500 Server exception Use the following URL https lt host gt lt port gt csa rest catalog userIdentifier 90d9652b35f46a930135f35b327e00a08scope basegdetail basic The following XML was returned in the response lt xml version 1 0 encoding UTF 8 standalone yes gt lt CatalogList gt lt count gt 12 lt count gt lt limit gt e lt limit gt lt catalog gt lt id gt 402895e566cb32ss0136cb831752000f lt id gt HP Cloud Service Automation 4 10 Page 47 of 150 API Reference lt objectId gt 402895e566cb32ss0136cb831752000f lt objectId gt lt createdO0n gt 2012 04 19T09 23 04 913 06 00 lt createdOn gt lt updatedOn gt 2012 04 19T09 23 04 913 06 00 lt updatedOn gt lt isCriticalSystemObject gt false lt isCriticalSystemObject gt lt description gt Default catalog for the organization lt description gt lt name gt consumer catalo
91. emObject gt false lt isCriticalSystemObject gt lt name gt INITIALIZED lt name gt lt disabled gt false lt disabled gt lt processInstanceState gt lt context gt Context for Unit Test Process Instance lt context gt lt artifactId gt ID of the artifact executing the action lt artifactId gt lt timeout gt 3600 lt timeout gt lt errorOnTimeout gt false lt errorOnTimeout gt lt ProcessInstance gt Update a process instance Details URI processinstances lt process instance id gt Where lt process instance id gt is the process instance ID Method PUT HP Cloud Service Automation 4 10 Page 122 of 150 API Reference URI Parameters Request Body Response Body Returns processinstances lt process_instance_id gt Where lt process_instance_id gt is the process instance ID userIdentifier lt user_id gt Required the user ID you want to use as credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier value view lt view_type gt amp scope view Optional used to update process instance based on pre defined views Possible values for view_type are propertyinfo and processinstancestate With processinstancestate the process instance state return code and status can be changed lt property_ gt action lt _ gt merge Optional use the merge option with the action meta tag query parameter to update only a portion of the process instance The follo
92. ence Cloud Service Automation 4 10 Just add your feedback to the email and click send If no email client is available copy the information above to a new message in a web mail client and send your feedback to CSAdocs hp com HP Cloud Service Automation 4 10 Page 149 of 150
93. ers userIdentifier lt user_id gt Required the user ID you want to use as credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier value Returns 200 Ok 401 Not authorized 404 Object not found 500 Server exception The types of approval policies supported are NamedApproverApprovalTemplate NamedGroupApprovalTemplate UserContextApprovalTemplate and DelegatedApprovalTemplate In NamedApproverApprovalTemplate request body e displayName is required e approver is optional e 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 e automaticApproval is optional if not present default to false If automaticApproval is true a automaticPeriodDuration in days is optional if not present defaults to 0 Valid value is integer from 0 to 365 automaticApprovalDecision is required valid value is APPROVED or REJECTED Example request body lt NamedApproverApprovalTemplate gt lt displayName gt Name Ex Template 03 lt displayName gt lt approver gt lt userName gt consumer lt userName gt lt approver gt lt approver gt lt userName gt consumer 4 lt userName gt lt approver gt lt minApprovalRequired gt 1 lt minApprovalRequired gt lt automaticApproval gt true lt automaticApproval gt lt automaticPeriodDuration gt 12 lt autom
94. ffering with id 8a81818f3d4251ed013d427c75e127c3 lt messages gt lt messages gt Failed to set approval policy for service offering with id 12345 Th e service offering is not found lt messages gt lt messageList gt List subscriptions in the catalog Deprecation Notice The GET catalog lt catalog_id gt subscription URI has been deprecated Use URI user mysubscription instead as using the deprecated URI will not allow viewing subscriptions created by users who previously had access to the catalog but no longer have access Details URI catalog lt catalog id gt subscription Use List catalogs on page 47 to get the catalog ID Method GET Parameters userIdentifier lt user_id gt 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 userldentifier on page 91 for the steps required to get the userldentifier value scope base view Optional default is base detail basic Optional The only valid value is basic requestor lt user_name gt Optional user name must be valid and must be authorized to view the request Returns 200 Ok 401 Not authorized 500 Server exception Examples The following URL was sent https lt host gt lt port gt csa rest catalog 402895e33732af18013732b6f435006b subscription userIdentifier 90d9652b67ss6a930135f35b327e0020 HP Cloud Service Aut
95. g a lt name gt lt displayName gt Consumer Catalog A lt displayName gt lt state gt lt id gt 90d96588364da0c701370da0ss320037 lt id gt lt objectId gt 90d96588364da0c701370da0ss320037 lt objectId gt lt createdOn gt 2012 04 19T09 22 25 943 06 00 lt createdOn gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt description gt Active lt description gt lt iconUr1 gt csa images categories artifact_state active png lt iconUr1 gt lt name gt ACTIVE lt name gt lt displayName gt Active lt displayName gt lt disabled gt false lt disabled gt lt categoryType gt lt id gt 90d96588364da0c701370da055320038 lt id gt lt objectId gt 90d96588364da0c701370da0ss320038 lt objectId gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt name gt ARTIFACT_STATE lt name gt lt displayName gt Artifact State lt displayName gt lt extensible gt false lt extensible gt lt categoryType gt lt state gt lt artifactType gt lt id gt 90d96588364da c 701370da ss320039 lt id gt lt objectId gt 90d96588364da0c 701370da0ss320039 lt objectId gt lt createdOn gt 2012 04 19T09 22 26 050 06 00 lt createdOn gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt description gt Catalog lt description gt lt iconUr1 gt csa images categories artifact_type catalog png lt iconUr1 gt lt name gt CATALOG lt name gt lt displayName gt Catalog lt displayName gt lt disabled gt f
96. gt lt name gt ARTIFACT_STATE lt name gt lt displayName gt Artifact State lt displayName gt lt extensible gt false lt extensible gt lt categoryType gt lt state gt lt artifactType gt 1 gt lt a lt di lt pa lt id gt 90d96588360da0c701360da0eefc002a lt id gt lt objectId gt 90d96588360da0c701360da0eefce02a lt objectId gt lt createdOn gt 2012 06 21T11 51 43 253 07 00 lt createdOn gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt description gt Organization lt description gt lt iconUr1 gt csa images categories artifact_type organization png lt iconUr lt name gt ORGANIZATION lt name gt lt displayName gt Organization lt displayName gt lt disabled gt false lt disabled gt lt categoryType gt lt id gt 90d96588360da0c701360da0eeb40017 lt id gt lt objectId gt 90d96588360da0c701360da0eeb40017 lt objectId gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt name gt ARTIFACT_TYPE lt name gt lt displayName gt Artifact Type lt displayName gt lt extensible gt false lt extensible gt lt categoryType gt rtifactType gt sabled gt false lt disabled gt rtyType gt lt id gt 90d96588360da0c701360da0eff1005d lt id gt lt objectId gt 90d96588360da0c701360da0eff1005d lt objectId gt lt createdOn gt 2012 06 21711 51 43 293 07 00 lt createdOn gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt description gt Organization lt descr
97. gt 1 lt count gt lt limit gt lt limit gt lt ServiceOffering gt lt id gt 90e763db3ed8fe91013ed9017c4e0264 lt id gt lt created0n gt 2013 05 24T17 05 53 358 07 00 lt createdOn gt lt updatedOn gt 2013 05 24T17 06 05 287 07 00 lt updatedOn gt lt isCriticalSystemObject gt false lt isCriticalSystemObject gt lt description gt Ready to do more today Standardize on Red Hat Enterprise Linu x and get more of everything you expect from an enterprise class open source ope rating system with flexibility efficiency and control lt description gt lt detailedDescription gt Ready to do more today Standardize on Red Hat Enterpr ise Linux and get more of everything you expect from an enterprise class open so urce operating system with flexibility efficiency and control lt detailedDescrip tion gt lt iconUr1 gt csa images offerings Microsoft Frontpage icon png lt iconUr1 gt lt name gt Enterprise Red Hat Linux Server lt name gt lt displayName gt Enterprise Red Hat Linux Server lt displayName gt lt catalogItem gt lt id gt 90e763db3ed8fe91013ed901a9ae047d lt id gt lt catalog gt lt id gt 90e763db3ed8fe91013ed90156b100b4 lt id gt lt isCriticalSystemObject gt false lt isCriticalSystem0bject gt lt disabled gt false lt disabled gt lt catalog gt lt category gt lt id gt 90d96588360da0c701360da0f4cc00ec lt id gt lt isCriticalSystemObject gt false lt isCriticalSystem0Object gt lt name gt APPLICATION SERVERS lt nam
98. he following URL was sent https lt host gt lt port gt csa rest artifact 8a81818f3d02fb7e013d0308891d0003 group u serIdentifier 90d96588360da0c701360da0f1d5f483 The following XML was returned lt xml version 1 0 encoding UTF 8 standalone yes gt lt GroupList gt lt count gt 1 lt count gt lt limit gt 1 lt limit gt lt group gt lt id gt 8a81818f3d02fb7e013de30af854000F lt id gt lt isCriticalSystemObject gt false lt isCriticalSystemObject gt lt name gt sc_February 22 2013 5 54 43 PM UTC lt name gt lt displayName gt ServiceConsumer1 lt displayName gt lt state gt lt state gt lt artifactType gt lt artifactType gt lt disabled gt false lt disabled gt lt distinguishedName gt cn ServiceConsumer ou ConsumerGroup ou CSAGroups lt distinguishedName gt lt role gt lt role gt lt group gt lt GroupList gt HP Cloud Service Automation 4 10 Page 22 of 150 API Reference Add groups to an organization Details URI artifact lt organization_id gt group Method POST Parameters userIdentifier lt user_id gt Required the user ID you want to use as credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier 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 For Consumer type organi
99. ice requests successfully deleted A ServiceRequest element is included for each deleted service request lt ServiceRequestList gt lt count gt 2 lt count gt lt limit gt lt limit gt lt ServiceRequest gt lt id gt 90e72e283b05aff1013b0b2c015103234 lt id gt lt ServiceRequest gt lt ServiceRequest gt lt id gt 90e72e283b05aff1013b0b2b43fc0356 lt id gt lt ServiceRequest gt ServiceRequestList gt HP Cloud Service Automation 4 10 Page 135 of 150 API Reference List approvals for approver Details URI Method Parameters Returns user myapproval GET userIdentifier lt user_id gt 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 userldentifier on page 91 for the steps required to get the userldentifier value scope base view Optional default is base detail basic Optional The only valid value is basic returnRetired true false Optional default is false approver lt user_name gt Required user name must be valid and is the user whose approval list will be returned by this call approver must be in the same organization as the user specified by userldentifier creationStartDate lt yyyy MM ddTHH mm ss gt Optional approval requests created on or after start date and time will be included in the return T serves as a separator between data
100. id gt The following XML was sent in the request body lt ResourceProvider gt lt id gt 9 e72e4F3b00a69e013b0c049ab00033 lt id gt lt objectId gt 90e72e4F3b00a69e013b0c049abe0033 lt objectId gt lt createdOn gt 2012 11 16717 38 46 576 08 00 lt createdOn gt lt updatedOn gt 2012 11 16T17 38 46 576 08 00 lt updatedOn gt lt createdBy gt lt id gt 90d96588360da0c701360da0f1d5f483 lt id gt lt createdBy gt lt updatedBy gt lt id gt 90d96588360da0c701360da0f1d5f483 lt id gt lt updatedBy gt lt isCriticalSystemObject gt false lt isCriticalSystem0bject gt lt description gt TestProvider lt description gt lt name gt TestProvider_November 17 2012 1 38 46 AM UTC lt name gt lt displayName gt TestProviderModified lt displayName gt lt state gt lt id gt 90d96588360da0c701360da0ef470038 lt id gt lt state gt lt artifactType gt lt id gt 90d96588360da0c701360da0eed8001f lt id gt lt artifactType gt lt disabled gt false lt disabled gt lt accessPoint gt lt id gt 90e72e4f3b00a69e013b0c0492748032 lt id gt HP Cloud Service Automation 4 10 Page 16 of 150 API Reference lt accessPoint gt lt providerType gt lt id gt 90d96588360da0c701360da0eeaceo16 lt id gt lt providerType gt lt numberOfResourceOffering gt lt numberOfResourceOffering gt lt numberOfEnvironment gt lt numberOfEnvironment gt lt numberOfPools gt lt numberOfPools gt lt ResourceProvider gt Delete
101. ils on page 55 to get a service offering s policy ID POST userIdentifier lt user_id gt Required the user ID you want to use as credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier value The request body contains the list of service offering IDs that are to be updated The response body will be a MessageListVO with success and failure messages 200 Ok 401 Not authorized 404 Object not found 500 Server exception The following URL was sent https lt host gt lt port gt csa rest catalog 8a81818f3d4251ed013d46c2b7f602bc policy 8a81818f3d4251ed013d46cc8590012c setSOApprovalPolicy userTdentifier 90d96588360da0c701360da0f1d5f483 The following XML was sent in the request body lt ServiceOfferingList gt lt ServiceOffering gt lt id gt 8a81818f3d4251ed013d427c75e5005d lt id gt lt ServiceOffering gt lt ServiceOffering gt lt id gt 8a81818f3d4251ed013d427c75e127c3 lt id gt lt ServiceOffering gt lt ServiceOffering gt lt id gt 12345 lt id gt lt ServiceOffering gt lt ServiceOfferingList gt The following XML was returned HP Cloud Service Automation 4 10 Page 70 of 150 API Reference lt messageList gt lt messages gt Updated approval policy of action of ORDER for service offering with id 8a81818f3d4251ed013d427c75e5005d lt messages gt lt messages gt Updated approval policy of action of MODIFY_SUBCRIPTION for service o
102. ion 4 10 Method GET GET GET POST PUT DELETE GET PUT Parameters userldentifier scope detail userldentifier scope detail userldentifer userldentifer userldentifer userldentifer orgN ame userldentifier queryType newReleases Description View a list of organizations on the next page Note The user identified by userldentifier must have admin access View an organization on page 102 List organization s approval policies on page 105 Create approval policy on page 107 Update approval policy on page 110 Delete approval policy on page 112 Retrieve organization LDAP access point information on page 113 List most requested recently requested or new offerings on page 114 Page 99 of 150 API Reference View a list of organizations Details URI organization Method GET Parameters userIdentifier lt user_id gt Required the user ID you want to use as credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier value Note The user identified by userldentifier must have admin access scope base Optional the only valid value is base detail basic Optional The only valid value is basic Returns 200 Ok 401 Not authorized 500 Server exception Example The following URL was sent https localhost 8444 csa rest organization userIdentifier 90d96588360da0c701360da0f1d5f
103. ion gt lt minApprovalRequired gt 0 lt minApprovalRequired gt lt approvalLevel gt 1 lt approvalLevel gt lt approvalTemplate gt lt catalog gt lt id gt 8a81818f3d4251ed013d46c2b7f602bc lt id gt lt name gt SOFTWARE_CATALOG lt name gt lt catalog gt lt approvalPolicy gt lt approvalPolicy gt lt id gt 8a81818f3d4251ed013d46cc85e402c2 lt id gt lt approvalTemplate gt lt name gt USER CONTEXT APPROVAL TEMPLATE QAORG lt name gt lt automaticApproval gt false lt automaticApproval gt lt automaticPeriodDuration gt 0 lt automaticPeriodDuration gt lt minApprovalRequired gt 0 lt minApprovalRequired gt lt approvalLevel gt 1 lt approvalLevel gt lt approvalTemplate gt ee lt catalog gt lt id gt 82a81818f3d4251ed013d46c2b7f602bc lt id gt lt name gt SOFTWARE_CATALOG lt name gt lt catalog gt lt approvalPolicy gt lt ApprovalPolicyList gt Update service offerings approval policy Usethis API to update the approval policy for multiple service offerings published in the specified catalog HP Cloud Service Automation 4 10 Page 69 of 150 API Reference Details URI Method Parameters Request Body Response Body Returns Examples catalog lt calalog_id gt policy lt policy_id gt 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 deta
104. iption gt lt iconUr1 gt csa images categories party_type organization png lt iconUr1 gt lt name gt ORGANIZATION lt name gt lt displayName gt Organization lt displayName gt lt disabled gt false lt disabled gt lt categoryType gt HP Cloud Service Automation 4 10 Page 101 of 150 API Reference lt id gt 90d96588360da0c701360da0efe20059 lt id gt lt objectId gt 90d96588360da0c701360da0efe20059 lt objectId gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt name gt PARTY_TYPE lt name gt lt displayName gt Party Type lt displayName gt lt extensible gt false lt extensible gt lt categoryType gt lt partyType gt lt businessRole gt lt id gt 90d96588360da0c701360da0f0020061 lt id gt lt objectId gt 90d96588360da0c701360da0f0020061 lt objectId gt lt createdOn gt 2012 06 21711 51 43 300 07 00 lt createdOn gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt description gt Consumer lt description gt lt iconUr1 gt csa images categories business role consumer png lt iconUr1 gt lt name gt CONSUMER lt name gt lt displayName gt Consumer lt displayName gt lt disabled gt false lt disabled gt lt categoryType gt lt id gt 90d96588360da0c701360da0effd0060 lt id gt lt objectId gt 90d96588360da0c701360da0effde868 lt objectId gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt name gt BUSINESS ROLE lt name gt lt displayName g
105. l is set to true a automaticPeriodDuration in days is optional if not present defaults to 0 Valid value is integer from 0 to 365 automaticApprovalDecision is required valid value is APPROVED or REJECTED Example request body lt UserContextApprovalTemplate gt lt displayName gt User ContextTemplate 01 lt displayName gt lt automaticApproval gt true lt automaticApproval gt lt automaticPeriodDuration gt 7 lt automaticPeriodDuration gt lt automaticApprovalDecision gt lt name gt APPROVED lt name gt lt automaticApprovalDecision gt lt UserContextApprovalTemplate gt In DelegatedApprovalTemplate request body e displayName is required e processDefinition is required id is needed e automaticApproval is optional if not present defaults to false If automaticApproval is set to true HP Cloud Service Automation 4 10 Page 108 of 150 API Reference a automaticPeriodDuration in days is optional if not present defaults to 0 Valid value is integer from 0 to 365 automaticApprovalDecision is required valid value is APPROVED or REJECTED Example request body lt DelegatedApprovalTemplate gt lt displayName gt Name Ex Template 03 lt displayName gt lt processDefinition gt lt id gt 90d96507362a000a01362a0048bcO0ad lt id gt lt processDefinition gt lt automaticApproval gt true lt automaticApproval gt lt automaticPeriodDuration gt 30 lt automaticPeriodDuration gt lt automaticApprovalDeci
106. le lifecycle transition for service instance Details URI lifecycleengine execute Method POST Parameters userIdentifier lt user_id gt Required the user ID you want to use as credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier value Returns 200 Ok 401 Not authorized 404 Not found 500 Server exception Examples Use the following URL https lt host gt lt port gt csa rest lifecycleengine execute userIdentifier 90596588670da0c701360da0f1d540a1 The following XML was sent in the request HP Cloud Service Automation 4 10 Page 89 of 150 API Reference lt xml version 1 0 encoding UTF 8 standalone yes gt lt LifecycleExecutionRequest gt lt reverse gt false lt reverse gt lt serviceComponentId gt 90d96588372d758101372d75aebb009f lt serviceComponentId gt lt serviceInstanceld gt 90d96588372d758101372d75aeb90087 lt serviceInstanceld gt lt targetStateName gt DEPLOYED lt targetStateName gt lt LifecycleExecutionRequest gt HP Cloud Service Automation 4 10 Page 90 of 150 Chapter 9 Login API Description Use this API to provide credentials for CSA REST APIs Base URL https lt host gt lt port gt csa rest URIs The following URIs are appended to the base URL URI Method Parameters Nogin lt organization_ GET none name gt lt user_name gt ogin lt organization_ GET userName name gt userLookup Des
107. m 44 Request in o rd e mo 45 Approval miralo Mero id a ea o TA net o da 45 Approval Polley evocar e A 46 SUBS GNDLON a e e e art tS E e as ae 46 Resource Subscription 0 00 00 enn erna 46 sa RO I IR 46 Eistcataldgs sas A RA AR NES 47 Get catalog details 49 Create catalog categories 0000 rr 50 Update catalog categories 2222 2 52 Delete catalog category 0000 0 53 List offerings in the catalog 0000000 0000 54 Get offering details 00 cece cece eee cece cece ce ceeceeceteeeeeecececececnceeecseceeees 55 List requests in the catalog 0000 56 Deprecation NOtice coo cd to be do dae ae ei Z SEE 56 Submit a request g E EE 58 Getirequest details sn saka ss an a ad assa 60 Cancel a request 0000 cece cece cece ccc cece cece eeeeeeeeeeeseeneeees 63 Retire a request 0 22 c nce e cece cece eee ee cece ecceeeeeeeeeeeeees 63 List approvals in the catalog cece cece e ccc e eee eccccecceceeeeeeeeeees 64 Deprecation Notice 00 0 0 c eee ee eee eee eee e ee eeeeeeeeeeeees 64 Get approval details 00an aaien aana naonana eneennnni 65 Update approval decision using an external approvalsystem 65 Update approval decision using CSA approval process 66 Update catalog approval policies 000 68 Update service offerings approval policy 00 e cece cece eee eeee cess 69 Li
108. mit gt lt limit gt lt ApprovalProcess gt lt id gt 90e72e713294e0ab013aae76618e0e39 lt id gt lt ApprovalProcess gt lt ApprovalProcess gt lt id gt 90e2a4133a75430b013a7a1328560377 lt id gt lt ApprovalProcess gt lt ServiceSubscriptionList gt List subscriptions for user Details URI user mysubscription Method GET HP Cloud Service Automation 4 10 Page 138 of 150 API Reference URI Parameters Returns Examples user mysubscription userIdentifier lt user_id gt 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 userldentifier on page 91 for the steps required to get the userldentifier value scope base view Optional default is base detail basic Optional The only valid value is basic requestor lt user_name gt Required user name must be valid and is the user whose subscription list will be returned by this call requestor must be in the same organization as the user specified by userldentifier returnRetired true false Optional default is false creationStartDate lt yyyy MM ddTHH mm ss gt Optional subscriptions created on or after start date and time will be included in the return creationEndDate lt yyyy MM ddTHH mm ss gt Optional subscriptions created before end date and time will be included in the return Note that creationStartDate must also be specified
109. modificationStartDate lt yyyy MM ddTHH mm ss gt Optional subscriptions updated on or after specified start date and time will be included in the return modificationEndDate lt yyyy MM ddTHH mm ss gt Optional subscriptions updated before specified end date and time will be included in the return Note that modificationStartDate must also be specified Note that in all date parameters e Tserves as a separator between date and time e Time will default to 00 00 00 if not specified e Date and time are assumed to be in the time zone of the CSA server 200 Ok 401 Not authorized 500 Server exception The following URL was sent HP Cloud Service Automation 4 10 Page 139 of 150 API Reference https lt host gt lt port gt csa rest mysubscription userIdentifier 90d9652b67ss6a93013 5f35b327e0020 amp requestor RnDUser The following XML was returned lt xml version 1 0 encoding UTF 8 standalone yes gt lt ServiceSubscriptionList gt lt count gt 6 lt count gt lt limit gt lt limit gt lt ServiceSubscription gt lt id gt 90d957ea3806fa7e013807acc79000b3 lt id gt lt iconUr1 gt csa images library serviceOfferingDefault58 png lt iconUr1 gt lt name gt MY SR lt name gt lt displayName gt MY SR lt displayName gt lt state gt lt state gt lt artifactType gt lt name gt SUBSCRIPTION lt name gt lt artifactType gt lt disabled gt false lt disabled gt lt serviceOffering gt l
110. mple The following URL was sent https lt host gt lt port gt csa rest catalog 8a81818f3d02fb7e013d030889420004 category 8a81818f3d128500013d1341a5c6000d userIdentifier 90d96588360da0c701360da0f1d5f483 The following XML was sent in the request HP Cloud Service Automation 4 10 Page 52 of 150 API Reference lt CatalogCategory gt lt displayName gt Changing first example category name lt displayName gt lt iconUr1 gt catalog category x png lt iconUr1 gt lt description gt New description for first example category lt description gt lt CatalogCategory gt The following XML was returned lt xml version 1 0 encoding UTF 8 standalone yes gt lt Catalog gt lt id gt 8a81818f3d02fb7e013d0308894a0004 lt id gt lt isCriticalSystemObject gt false lt isCriticalSystemObject gt lt description gt Default catalog for the organization lt description gt lt iconUr1 gt csa images library briefcase consumer_default_img 60 png lt iconUr1 gt lt name gt Catalog QA ORG lt name gt lt displayName gt QA Org Catalog lt displayName gt lt catalogCategory gt lt catalogCategory gt lt catalogCategory gt lt id gt 82a81818f3d128500013d1341a5c6000d lt id gt lt isCriticalSystemObject gt false lt isCriticalSystem0Object gt lt description gt description for catalog category lt description gt lt iconUr1 gt catalog category x png lt iconUr1 gt lt name gt CHANGING_FIRST_EXAMPLE_CATEGORY_NAME
111. n HP Cloud Service Automation 4 10 Page 126 of 150 Chapter 15 User API Description Usethis API to get information related to CSA users Base URL https lt host gt lt port gt csa rest URIs The following URIs are appended to the base URL Request A request is created whenever a user initiates changes or deletes a subscription URI Method Parameters Description user instance lt instance__ GET userldentifier List service id gt request requests for subscription on page 129 user myrequest GET userldentifier scope detail List active submitter returnRetired requests for user submitStartDate on page 130 submitEndDate user request count GET userldentifier Get count of requests for user on page 132 user multipleRequest cancel POST userldentifier Cancel multiple service requests on page 133 user multipleRequest delete POST userldentifier Delete multiple service requests on page 134 Approval An approval is created when the approval manager approves a request HP Cloud Service Automation 4 10 Page 127 of 150 API Reference URI user approval count user multipleApprovals delete user myapproval Subscription Method GET POST GET Parameters userldentifier userldentifier userldentifier scope detail returnRetired approver creationStartDate CreationEndDate Description Get count of approvals for user on page 137 Delete multiple approval
112. n one of the following values a FAILURE a SUCCESS For service subscription artifacts status will be returned and will contain one of the following values ACTIVE CANCELLED EXPIRED PAUSED PENDING TERMINATED Example The following URL was sent https lt host gt lt port gt csa rest artifact state 90e72e323ad23bd6013ad23f63da0016 u serIdentifier 90d96588360da0c701360da0f1d5f483 The following JSON was returned in the response body id 90e72e323fe4c9ae013fe4def98a0125 artifactType SERVICE INSTANCE artifactState ACTIVE state FAILED status null gt Artifact views Artifact views provide a convenient way to perform retrieve or update actions When views are used with artifact GET and fastview GET requests the response includes only the relevant information depending on the type of view requested When used with PUT requests the body of the request can include just relevant information compared to typical PUT requests Advantages of Views HP Cloud Service Automation 4 10 Page 36 of 150 API Reference e 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 e 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 e Anexample of using views is presented in Update an artifact on page 14
113. n TestConsumer ou ConsumerGroup ou CSAGroups lt distinguishedName gt lt role gt lt isCriticalSystemObject gt false lt isCriticalSystem0bject gt lt name gt SERVICE_CONSUMER lt name gt lt disabled gt false lt disabled gt lt role gt lt group gt lt group gt lt isCriticalSystemObject gt false lt isCriticalSystemObject gt lt name gt Another Group Name lt name gt lt displayName gt Another Group Name lt displayName gt lt disabled gt false lt disabled gt lt distinguishedName gt cn TestConsumer2 ou ConsumerGroup ou CSAGroups lt distinguishedName gt lt role gt lt isCriticalSystem0bject gt false lt isCriticalSystemObject gt lt name gt SERVICE_CONSUMER lt name gt lt disabled gt false lt disabled gt lt role gt lt group gt lt GroupList gt HP Cloud Service Automation 4 10 Page 24 of 150 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 lt organization_id gt group lt group_id gt Method PUT Parameters userIdentifier lt user_id gt Required the user ID you want to use as credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier value Returns 200 Ok 401 Not authorized 404 Object not found 500 Server exception Example The following URL was sent https
114. n any failed action instances Parameters userIdentifier lt user_id gt Required the user ID you want to use as credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier value Method GET Returns 200 Ok 401 Not authorized 500 Server exception Examples The following URL was sent https lt host gt lt port gt csa rest user instance 90cec3a03a94d689013aa91e1b9b1218 re quest userIdentifier BFA0DB53DA414B90E04059106D1A24B5 The following XML was returned in the response lt xml version 1 0 encoding UTF 8 standalone yes gt gt lt ServiceRequestList gt lt count gt 3 lt count gt lt limit gt lt limit gt lt ServiceRequest gt lt id gt 90cec3a032667c69013a9331365f3a54 lt id gt lt createdOn gt 2012 10 11T22 03 27 361 07 00 lt createdOn gt lt updatedOn gt 2012 10 11T22 04 20 553 07 00 lt updatedOn gt lt createdBy gt lt createdBy gt lt updatedBy gt lt updatedBy gt HP Cloud Service Automation 4 10 Page 129 of 150 API Reference lt isCriticalSystemObject gt false lt isCriticalSystemObject gt lt description gt OctoberSampleService lt description gt lt iconUr1 gt csa images library Icon 34_48 png lt iconUr1 gt lt name gt Wednesday Demo lt name gt lt displayName gt Wednesday Demo lt displayName gt lt disabled gt false lt disabled gt lt requestState gt lt requestState gt lt requestedAc
115. name gt PRICE_CATEGORY lt name gt lt displayName gt Price Category lt displayName gt lt extensible gt false lt extensible gt lt categoryType gt riceCategory gt xedPrice gt 3000 0 lt fixedPrice gt itPrice gt 0 0 lt unitPrice gt Price gt Request gt HP Cloud Service Automation 4 10 Page 62 of 150 API Reference Cancel a request Details URI Method Parameters Returns catalog lt catalog_id gt request lt request_id gt 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 GET userIdentifier lt user_id gt 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 userldentifier on page 91 for the steps required to get the userldentifier value 200 Ok 401 Not authorized 404 Not found 500 Server exception Retire a request Details URI Method Parameters Returns catalog lt calalog id gt request lt request id gt 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 DELETE userIdentifier lt user_id gt 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 userldentifier
116. nce Delete document from service offering Details URI artifact lt service offering id gt document lt document id gt Method DELETE Parameters userIdentifier lt user_id gt Required the user ID you want to use as credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier value Returns 200 Ok 401 Not authorized 404 Object not found 500 Server exception Example The following URL was sent https lt host gt lt port gt csa rest artifact 90cef5de3c63429f013c68b8cddaBbad documen t 90cef5de3c63429f013c68b8cdda0bad userIdentifier 90cef5de3c63429f013c642c7fc708 ab The following XML was returned lt xml version 1 0 encoding UTF 8 standalone yes gt lt Document gt lt id gt 90cef5de3c63429f013c68d4146a0bce lt id gt lt isCriticalSystemObject gt false lt isCriticalSystemObject gt lt name gt Example Offering Doc txt lt name gt lt state gt lt state gt lt artifactType gt lt artifactType gt lt disabled gt false lt disabled gt lt ur1 gt csa document download id 90cef5de3c63429f013c68d4146a0bce lt url gt lt content gt Sample Doc Content lt content gt lt mimeType gt application octet stream lt mimeType gt lt documentType gt lt documentType gt lt Document gt HP Cloud Service Automation 4 10 Page 30 of 150 API Reference Update document in service offering Details URI Method Parameters Returns
117. ngs and resource environments of the same provider type and display name in the database validateType COMPONENT_PALETTE CATALOG SERVICE_OFFERING SERVICE_ BLUEPRINT RESOURCE OFFERING RESOURCE ENVIRONMENT Optional if specified content archive is verified to be of the specified type 200 Updated 400 Bad request 404 Not found 500 Server exception Caution Component palette import is an update operation and so associateProviders and updatePreserveE xisting parameters will be ignored The following headers must be set when using this API to upload the content archive e Content type multipart form data e Content Disposition form data name file HP Cloud Service Automation 4 10 Page 80 of 150 API Reference e Content Type application octet stream Example The following URL was sent to import the contents of the specified archive https lt host gt lt port gt csa rest import userIdentifier 90d96588360da0c701360da0f1d 5f4838update truegfile SERVICE_OFFERING_SO_ONE_ 906cec2ff3c81b896013c81b8c1780097 zip The following XML was returned lt xml version 1 0 encoding UTF 8 standalone yes gt lt ImportOperationResult gt lt additionalSummaryMessages gt Service offering SO ONE imported successfully Id 9 cec2ff3dc1d73b013dc1df0 b750028 lt additionalSummaryMessages gt lt additionalSummaryMessages gt Service design SD ONE imported successfully Id 90cec2ff3dc1d73b013dc1df09d b0018
118. nsumer user who has the necessary permissions for the data you want to work with See Get userldentifier on page 91 for the steps required to get the userldentifier value scope base baseplusone subtree 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 retumed If value is subtree then the object and all of its descendants are retumed detail required basic standard template full Optional default is full See Values for the detail parameter on page 147 Some API calls do not support all possible values for this parameter Returns 200 Ok 401 Not authorized 404 Not found 500 Server exception Retire an approval Details URI catalog lt catalog idid gt approval lt approval id gt Method DELETE HP Cloud Service Automation 4 10 Page 75 of 150 API Reference URI Parameters Returns catalog lt catalog_idid gt approval lt approval_id gt userIdentifier lt user_id gt 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 userldentifier on page 91 for the steps required to get the userldentifier value 200 Ok 401 Not authorized 404 Not found 500 Server exception Caution The approval is retired regardless of whether it was rejected or approved Get resource
119. ntentBody gt lt recipient gt lt id gt 90cec3a03a93ef89013a93f07b880001 lt id gt lt type gt PERSON lt type gt lt recipient gt lt recipient gt lt id gt bad org id lt id gt lt type gt ORGANIZATION lt type gt lt recipient gt lt tokens gt lt tokenSequence gt lt tokenSequence gt lt value gt Token O test content lt value gt lt tokens gt lt tokens gt lt tokenSequence gt 1 lt tokenSequence gt lt value gt Token 1 test content lt value gt lt tokens gt lt Notification gt The following response header status code was returned 208 OK The following XML was returned lt xml version 1 0 encoding UTF 8 standalone yes gt lt NotificationPostResponse gt lt count gt 1 lt count gt lt errorMessage gt Please enter a valid value for the recipient user id bad org id lt errorMessage gt lt notification gt lt notifContentBody gt Test content body token 0 Token1 1 lt notifCo ntentBody gt lt notifCreatedon gt 2012 11 14T110 25 06 021 07 00 lt notifCreatedOn gt lt notifSubject gt Test Subject lt notifSubject gt lt notifactionId gt 90cec39c3ae64d82013afff3e9c3002c lt notifactionId gt lt recepientArtifactTypeld gt 90d96588360da0c701360da0ef03002c lt recepientArtifactTypeld gt lt recepientArtifactTypeName gt PERSON lt recepientArtifactTypeName gt lt recepientEmailAddr gt acctgconsumer econ csa com lt recepientEmailAddr gt lt recepientId gt 90cec32a03a93ef89013a
120. o work with See Get userldentifier on page 91 for the steps required to get the userldentifier value scope base view Optional default is base detail basic Optional The only valid value is basic requestor lt user_name gt Optional user name must be valid and must be authorized to view the request Returns 200 Ok 401 Not authorized 500 Server exception Examples The following URL was sent https lt host gt lt port gt csa rest catalog 492895e33732af18013732b6f435006b instance userIdentifier 90d9652b67ss6a930135f35b327e0020 The following XML was returned lt ServiceInstanceList gt lt count gt 6 lt count gt lt 1limit gt 0 lt limit gt lt ServiceInstance gt lt id gt 90d957ea3806fa7e01380f957d11070a lt id gt lt name gt MYSD_June 5 2012 5 19 51 PM UTC lt name gt HP Cloud Service Automation 4 10 Page 74 of 150 API Reference lt displayName gt MYSD lt displayName gt lt state gt lt state gt lt serviceInstanceState gt lt serviceInstanceState gt lt ServiceInstance gt lt ServiceInstanceList gt Get instance details Details URI catalog lt catalog id gt instance lt instance id gt 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 lt user_id gt Required the user ID you want to use as credentials for this API call This user should be a co
121. ocess Instance has successfully completed lt status gt lt ProcessInstance gt Execute a process instance Details URI processinstances lt process instance id gt execute Method POST Parameters userIdentifier lt user_id gt Required the user ID you want to use as credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier value Response ProcessInstance VO Body Returns 200 Ok 401 Not authorized 404 Not found 500 Server exception The following was sent to retrieve a process instance https lt host gt lt port gt csa rest processinstances 90d9652b362d4ecd01362d4fb7be0f71 execute userIdentifer 90d9652b35f352930135f35b327e0020 HP Cloud Service Automation 4 10 Page 125 of 150 Chapter 14 Search API Details URI search Method GET Parameters userIdentifier lt user_id gt 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 userldentifier on page 91 for the steps required to get the userldentifier value query lt string gt Required returns search results that contain string in their display name or description type all1 subscription service_offering service_request approval_ process Optional default is all The type of objects to search Returns 200 Ok 401 Not authorized 500 Server exceptio
122. ollowing URL was sent https lt host gt lt port gt csa rest availablevalues 90e763a43ddc18e5013ddc2f134c0088 userTdentifier 90d96588360da0c701360da0f1d5f483 The following was sent in the request body HP Cloud Service Automation 4 10 Page 42 of 150 API Reference first parentiValue The following response was returned lt Property gt lt id gt 90e763a43ddc18e5013ddc2f134c0088 lt id gt lt name gt child1 lt name gt lt displayName gt child1 lt displayName gt lt dynamicValueEnabled gt true lt dynamicValueEnabled gt lt dynamicScriptName gt sample_jsp jsp lt dynamicScriptName gt lt dynamicScriptParameters gt first CLIENT parent1 lt dynamicScriptParameters gt lt availableValues gt lt value gt value1 lt value gt lt displayName gt value1 displayName lt displayName gt lt description gt valuel description lt description gt lt availableValues gt lt Property gt HP Cloud Service Automation 4 10 Page 43 of 150 Chapter 3 Catalog API Description Use this API to get information related to CSA catalogs Base URL https lt host gt lt port gt 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 userldentifier scope detail List catalogs on page 47 catalog lt catalog_id gt GET userldentifier scope detail Get catalog details on page 49
123. ollowing URL was sent to reject a subscription request https lt host gt lt port gt csa rest catalog The following XML was sent in the request lt ApprovalProcess gt lt approvalResult gt lt name gt REJECTED lt name gt lt approvalResult gt lt approvalComment gt comment lt approvalComment gt lt ApprovalProcess gt Update approval decision using CSA approval process Details URI catalog lt calalog_id gt approval lt approval_id gt 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 Method PUT HP Cloud Service Automation 4 10 Page 66 of 150 API Reference URI catalog lt calalog_id gt approval lt approval_id gt 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 lt user_id gt 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 userldentifier on page 91 for the steps required to get the userldentifier value Body ApprovalProcess instance required in request body Returns 200 Ok 401 Not authorized 404 Not found 500 Server exception Examples The following URL was sent to approve a subscription request https lt host gt lt port gt csa rest catalog 90540a9734f50288013
124. omation 4 10 Page 71 of 150 API Reference The following XML was returned lt xml version 1 0 encoding UTF 8 standalone yes gt lt ServiceSubscriptionList gt lt count gt 6 lt count gt lt limit gt 0 lt limit gt lt ServiceSubscription gt lt id gt 90d957ea3806fa7e013807acc79000b3 lt id gt lt iconUr1 gt csa images library serviceOfferingDefault58 png lt iconUr1 gt lt name gt MY SR lt name gt lt displayName gt MY SR lt displayName gt lt state gt lt state gt lt artifactType gt lt name gt SUBSCRIPTION lt name gt lt artifactType gt lt disabled gt false lt disabled gt lt serviceOffering gt lt serviceOffering gt lt subscriptionStatus gt lt subscriptionStatus gt lt initiatingServiceRequest gt lt initiatingServiceRequest gt lt ServiceSubscription gt lt ServiceSubscriptionList gt Get subscription details Details URI Method catalog lt catalog id gt subscription lt subscription_id gt 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 GET Parameters userIdentifier lt user_id gt 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 userldentifier on page 91 for the steps required to get the userldentifier value scope b
125. on page 91 for the steps required to get the userldentifier value 200 Ok 401 Not authorized 404 Not found 500 Server exception HP Cloud Service Automation 4 10 Page 63 of 150 API Reference List approvals in the catalog Deprecation Notice The GET catalog lt catalog_id gt 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 Method Parameters Returns catalog lt catalog id gt approval Use List catalogs on page 47 to get the catalog ID GET userIdentifier lt user_id gt 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 userldentifier on page 91 for the steps required to get the userldentifier 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 If value is subtree then the object and all of its descendants are returned If the value is view then the view parameter is required detail required basic standard template full Optional default is basic See Values for the detail parameter on page 147 Some API calls do not sup
126. ope base Optional the only valid value is base detail basic Optional The only valid value is basic requestor lt user_name gt Required user name must be valid and is the user whose subscription list will be returned by this call requestor must be in the same organization as the user specified by userldentifier creationStartDate lt yyyy MM ddTHH mm ss gt Optional instances for subscriptions created on or after start date and time will be included in the return T serves as a separator between data and time Time will default to 00 00 00 if not specified Date and time are assumed to be in the time zone of the CSA server creationEndDate lt yyyy MM ddTHH mm ss gt Optional instances for subscriptions created before end date and time will be included in the return T serves as a separator between data and time Time will default to 00 00 00 if not specified Date and time are assumed to be in the time zone of the CSA server 200 Ok 401 Not authorized 500 Server exception The following URL was sent https lt host gt lt port gt csa rest user myinstance ruserIdentifier 90d9652b67ss6a9301 35f35b327e00a0 amp requestor johnsmith The following XML was returned in the response HP Cloud Service Automation 4 10 Page 143 of 150 API Reference lt xml version 1 0 encoding UTF 8 standalone yes gt lt ServiceInstanceList gt lt count gt 6 lt count gt lt limit gt 0 lt limit gt lt ServiceInstan
127. or the data you want to work with See Get userldentifier on page 91 for the steps required to get the userldentifier value scope base view Optional default is base detail basic Optional The only valid value is basic hasApproval true false Optional default is false If true then hasApproval attribute is returned If false then the attribute is not returned Returns 200 Ok 401 Not authorized 500 Server exception Examples The following URL was sent to get a list of offerings in a catalog using the default values for scope base and detail basic https lt host gt lt port gt csa rest catalog 402895e33732af18013732b6f435006boffering userIdentifier 90d9652b67ss6a930135f35b327ee0a0 The following XML was returned in the response HP Cloud Service Automation 4 10 Page 54 of 150 API Reference lt xml version 1 0 encoding UTF 8 standalone yes gt lt ServiceOfferingList gt lt count gt 3 lt count gt lt limit gt e lt limit gt lt ServiceOffering lt id gt 90e763db3dd1a9a4913dd1e16aa16c95 lt id gt lt objectId gt 90e763db3dd1a9a49013dd1e16aa16c95 lt objectlId gt lt createdOn gt 2013 04 03114 50 43 873 07 00 lt createdOn gt lt updatedOn gt 2013 04 03T14 50 43 873 07 00 lt updatedOn gt lt isCriticalSystemObject gt false lt isCriticalSystemObject gt lt description gt 3 Level Option for testing service offerings Integration Servic e Offering lt description gt lt artifactType
128. oup Gailly and Mark Adler Documentation Updates The title page of this document contains the following identifying information e Software Version number which indicates the software version e Document Release Date which changes each time the document is updated e 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 com selfsolve manuals This site requires that you register for an HP Passport and sign in To register for an HP Passport ID go to http h20229 www2 hp com passport registration html Or click the New users please register link on the HP Passport login page You will also receive updated or new editions if you subscribe to the appropriate product support service Contact your HP sales representative for details 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 As a valued support customer you can benefit by using the support web site to e Search for knowledge documents of interest Submit and track support case
129. port all possible values for this parameter approver lt user_name gt Optional the name of the approver returnRetired true false Optional default is false Caution The users specified by userIdentifierand approvermust be in the same organization 200 Ok 401 Not authorized 500 Server exception HP Cloud Service Automation 4 10 Page 64 of 150 API Reference Get approval details Details URI Method Parameters Returns catalog lt calalog_id gt approval lt approval_id gt 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 GET userIdentifier lt user_id gt 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 userldentifier on page 91 for the steps required to get the userldentifier value scope base baseplusone subtree 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 retumed If value is subtree then the object and all of its descendants are retumed detail required basic standard template full Optional default is full See Values for the detail parameter on page 147 Some API calls do not support all possible values for this parameter 200 Ok 401 Not authorized 404 Not found
130. pr lt p lt fi lt un lt base lt Service iption gt SD2 Offering lt description gt ledDescription gt desc SD2 offering lt detailedDescription gt rl gt csa images library application png lt iconUrl gt request 1 lt name gt ayName gt request 1 lt displayName gt ogItem gt gt 8a8181853810699a01381079202c00d7 lt id gt eatedOn gt 2012 06 21T12 16 09 900 07 00 lt createdOn gt datedOn gt 2012 06 21T12 16 09 900 07 00 lt updatedOn gt eatedBy gt lt id gt 8a8181853810699a01381076be5400a0 lt id gt lt objectId gt 8a8181853810699201381076be5400a0 lt objectId gt lt isCriticalSystemObject gt false lt isCriticalSystem0bject gt lt name gt consumer1 lt name gt lt disabled gt false lt disabled gt reatedBy gt iceCategory gt lt id gt 90d9650a36897af90136897bc93e0016 lt id gt lt objectId gt 90d9650a36897af90136897bc93e0016 lt objectId gt lt createdOn gt 2012 06 21711 51 43 633 07 00 lt createdOn gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt description gt SETUP lt description gt lt iconUr1 gt csa images categories price setup png lt iconUr1 gt lt name gt SETUP lt name gt lt displayName gt SETUP lt displayName gt lt disabled gt false lt disabled gt lt categoryType gt lt id gt 90d9650a36897af90136897bc7c70014 lt id gt lt objectId gt 90d9650a36897af90136897bc7c70014 lt objectId gt lt isCriticalSystemObject gt false lt isCriticalSystemObject gt lt
131. providerpools artifact views while the provider selection is in progress the list of providers will be returned Once a provider is selected no list will be returned HP Cloud Service Automation 4 10 Page 41 of 150 Chapter 2 Availablevalues API Description Use this API to retrieve the list of available values for a dynamic property Base URL https lt host gt lt port gt csa rest Details URI availablevalues lt property_id gt property idis an option model property and is part of service design offering and subscription artifacts Method POST Parameters userIdentifier lt user_id gt Required the user ID you want to use as credentials for this API call See Get userldentifier for the steps required to get the userldentifier value Request Ampersand amp separated name value pairs where the value on the left side of Body the equal sign represents the parameter name configured for a dynamic property and the value on the right side is the value the user selected from the parent property For example a request body might contain first parent1value amp countparam mycount 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 Example The f
132. pter 11 Organization API 99 URS reset hed a dd ar a ds no Sake secre 99 View alist of organizations 0000 100 View an organization 1 2 0 2 2 cece cece 0000 rare 102 List organization s approval policies 000 cece e cece eeeeeeeees 105 Create approval DOG 107 Update approval policy 00 00 00 0000 rr 110 HP Cloud Service Automation 4 10 Page 5 of 150 API Reference Contents Delete approval policy 00000 0000 0 000 112 Retrieve organization LDAP access point Information 0000 113 List most requested recently requested or new offerings 0 114 Chapter 12 orglnformation ARI 117 Chapter 13 Processinstances AW 118 RS Alo Td AGN UR eee es Ad uae 118 Process Instance structure 00 00 0000 000 118 Retrieve a process instance 2 2 2 ccc cece cc cc cece cece aoaaa a aonana nnn 119 Create a process instanc iison a L a a A a a 121 Update a process instance 2 2 cece eee ccc cence eee cc cceeeeeceeececeeeeees 122 Execute a process instance _ 2 2 02 2 cece eee ccc c eee ec cece cccceeeecceeeeeeeees 125 Chapter 14 Search ADI 126 Chapter 15 USE AP woe oc sn a luce oie neue et ey 127 A A A ES 127 Request ianea eoe a dl do o A daar eat 127 Approval ks 127 SU SENPUOM A A estas de 128 Tae TT 129 List service requests for Subscription 222 2222 22 cece eee ccceee ee c
133. r 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 x and that are still available in CSA 4 x Information on REST APIs introduced in CSA 4 x can be found in the HP Cloud Service Automation API Quick Start The base URL for a CSA REST API is https lt host port gt csa rest which is appended with the specific URI for the API call For example to access the lt example gt API you would use the URL https lt host port gt csa rest lt example gt Because XML content passed into or returned by CSA REST API calls can be lengthy example XML content presented in this document will often be abbreviated to include just the more pertinent XML content Note Special or localized characters used in the URL of REST API calls must be encoded before they are sent to the server Tip You should only include one value for a Boolean property and the value must be either true or false HP Cloud Service Automation 4 10 Page 8 of 150 Chapter 1 Artifact API Description Use this API to view create and modify CSA artifacts Base URL https lt host gt lt port gt csa rest URIs The following URIs are appended to the base URL Artifact URI Method artifact POST artifact lt artifac
134. r lt userName gt lt approver gt lt approver gt lt id gt 8a81818f3d1437e2013d177b13f107dd lt id gt lt userName gt ProjectManager lt userName gt lt approver gt lt NamedApproverApprovalTemplate gt Update approval policy Details URI organization lt organization_id gt approvalPolicy lt policy_id gt Method PUT HP Cloud Service Automation 4 10 Page 110 of 150 API Reference URI organization lt organization id gt approvalPolicy lt policy id gt Parameters userldentifier lt user id gt Required the user ID you want to use as credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier value Returns 200 Ok 401 Not authorized 404 Object not found 500 Server exception Example The following URL was sent https lt host gt lt port gt csa rest organization 8a81818f3d1421e7013d142363520003 approvalPolicy 8a81818f3d1437e2013d17f249c30a0c gt userTdentifier 90d96588360da0c701360da0f1d5f483 The following XML was sent in the request It will change the list of approvers to user ProjectManager set automaticApproval to false and set automaticApprovalDecision to REJECTED lt NamedApproverApprovalTemplate gt lt displayName gt Updated My Approval Template lt displayName gt lt approver gt lt userName gt ProjectManager lt userName gt lt approver gt lt minApprovalRequired gt lt minApprovalRequired gt lt automaticApproval
135. rence lt importOperation gt Error lt importOperation gt lt importResultLogEntry gt lt importResultLogEntry gt lt artifactDescription gt SD ONE lt artifactDescription gt lt artifactDisplayName gt SD ONE lt artifactDisplayName gt lt artifactName gt SD ONE February 11 2013 7 03 41 PM UTC lt artifactName gt lt artifactType gt SERVICE_BLUEPRINT lt artifactType gt lt importOperation gt Error lt importOperation gt lt importResultLogEntry gt lt importSummary gt Import of Service offering archive successful lt importSummary gt lt status gt SUCCESS lt status gt lt timeOfImport gt March 31 2013 7 19 01 PM UTC lt timeOfImport gt lt userInformation gt admin lt userInformation gt lt ImportResult HP Cloud Service Automation 4 10 Page 86 of 150 Chapter 8 Lifecycle engine API Description Use this API to work with lifecycle actions Base URL Base URL https lt host gt lt port gt csa rest URIs The following URIs are appended to the base URL URI Method Parameters Description lifecycleengine GET userldentifier Get latest lifecycle execution servicelnstanceld record for a service instance on page 89 lifecycleengine lt lifecycle_ GET userldentifer Get details for a lifecycle execution action_id gt record below lifecycleengine execute POST userldentifier Schedule lifecycle transition for service instance on page 89 Get details for a lifecycle execution record Details URI lifecy
136. return CRLF join f readlines def encode_multipart_formdata filename BOUNDARY CSA reck 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 append get file contents filename L append BOUNDARY L append body CRLF join L content type multipart form data boundary s BOUNDARY return content type body def addDocumentToOffering offeringId documentName userId conn HTTPSConnection localhost 8444 userAndPass b64encode b csaTransportUser csaTransportUser decode asci i post url csa rest artifact offeringld document userIdentifier userId content_type body encode_multipart_formdata documentName content length str len body headers Authorization Basic s userAndPass Content Type s content type content length str len b ody Accept application xml conn request POST post_url body headers headers res conn getresponse data res read print data def main offeringId documentName userId addDocumentToOffering offeringId documentName userId if name _main_ offeringId sys argv 1 documentName sys argv 2 userId sys argv 3 main offeringId documentName userId HP Cloud Service Automation 4 10 Page 29 of 150 API Refere
137. rm data e Content Disposition form data name file e Content Type application octet stream https lt host gt lt port gt csa rest artifact 90cef5de3c63429f013c68b8cddaBbad documen t userTdentifier 90cef5de3c63429f013c642c7fc708ab To better demonstrate how to use this REST API URI the following a python script attaches a text file to a service offering The script was created based on HTML documentation You can find information on html form content types at http www w3 org TR htm 401 interact forms html h 17 13 4 2 Sample python script that attaches a text file in the current directory to an ACTIVE CSA service offering on a local host with default credentials Script usage lt scrip name py gt lt service offering uuid gt lt filename gt lt admin uuid gt The following example attaches file doc txt to the service offering with id 90ce c0773c83a11a013c871e4c1a0503 using an admin user ID 90d96588360da0c701360da0f1d5f483 post doc py 9 cec 773c83a11a013c871e4c1a0503 doc txt 90d96588360da0c701360da0f1d 51483 Tested with ActivePython 3 2 2 3 from xml dom minidom import parse parseString from http client import HTTPSConnection from base64 import b64encode import mimetypes HP Cloud Service Automation 4 10 Page 28 of 150 API Reference import sys def get content type filename return mimetypes guess type filename or application octet stream def get file contents filename CRLF r n T open filename r
138. rsion 1 0 encoding UTF 8 standalone yes gt lt AccessPointinfo gt lt password gt JfyPejrtsQc0J4bKDPmznlg lt password gt lt searchSubtree gt false lt searchSubtree gt lt uri gt ldap localhost 389 dc csa dc org lt uri gt lt userSearchBase gt ou eConsumerUsers ou EnterpriseUsers lt userSearchBase gt lt userSearchFilter gt uid 0 lt userSearchFilter gt lt username gt cn admin dc csa dc org lt username gt lt AccessPointinfo gt List most requested recently requested or new offerings Details URI Method Parameters Returns organization offering Organization is determiend by userldentifier GET userIdentifier lt user_id gt Required the user ID you want to use as credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier value queryType mostRequested recentlyRequested newReleases Optional the ten most requested most recently requested or newly released offerings in all catalogs for the organization are returned 200 Ok 401 Not authorized 404 Not found 500 Server exception HP Cloud Service Automation 4 10 Page 114 of 150 API Reference Example The following URL was sent https lt host gt lt port gt csa rest organization offering userIdentifier 90e763db3ed8 fe91013ed90155e600b08queryType mostRequested The following XML was returned in the response lt ServiceOfferingList gt lt count
139. s catalog lt calalog_id gt policy lt policy_id gt setCatalogApprovalPolicy Use Catalog API on page 44 to get the catalog ID Use List organization s approval policies on page 105 to get an organization s approval policy IDs POST userIdentifier lt user_id gt Required the user ID you want to use as credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier value The response body will be an ApprovalPolicyVO of base full 200 Ok 401 Not authorized 404 Object not found 500 Server exception The following URL was sent https lt host gt lt port gt csa rest catalog 8a81818f3d4251ed013d46c2b7f602bc policy 8a81818f3d4251ed013d4259f57c0008 setCatalogApprovalPolicy gt userIdentifier 90d96588360da0c701360da0f1d5f483 The following XML was returned lt xml version 1 0 encoding UTF 8 standalone yes gt lt ApprovalPolicyList gt lt count gt 2 lt count gt lt limit gt lt limit gt lt approvalPolicy gt HP Cloud Service Automation 4 10 Page 68 of 150 API Reference lt id gt 8a81818f3d4251ed013d46cc859002c1 lt id gt lt approvalTemplate xsi type namedApproverApprovalTemplatevVo gt lt id gt 82a81818f3d4251ed013d46cc31ed02be lt id gt lt name gt EXAMPLE APPROVAL POLICY March 7 2013 9 40 19 PM UTC lt name gt lt automaticApproval gt false lt automaticApproval gt lt automaticPeriodDuration gt 0 lt automaticPeriodDurat
140. s and enhancement requests Download software patches Manage support contracts Look up HP support contacts Review information about available services Enter into discussions with other software customers Research and register for software training Most of the support areas require that you register as an HP Passport user and sign in Many also require a support contract To register for an HP Passport ID go to http h20229 www2 hp com passport registration html To find more information about access levels go to http h20230 www2 hp com new access levels jsp HP Software Solutions Now accesses the HPSW Solution and Integration Portal Web site This site enables you to explore HP Product Solutions to meet your business needs includes a full list of Integrations between HP Products as well as a listing of ITIL Processes The URL for this Web site is http h20230 www2 hp com sc solutions index jsp HP Cloud Service Automation 4 10 Page 2 of 150 Contents SON ts 3 HP CSA 4 x API Reference Introduction 0000 8 Chapter 1 Artifact API 00000000 rr 9 AA IR TOATE E a E 9 AG lok A ces ire AA dak A AAA Heh arnt 9 GOUD a ON Utne ee om neta teak dyes 9 RESQUICO PROVIDED 2 oo estes ir elo nd Seale taa 10 Service OMENNG a dls she ahve a a 10 Artifact ty POS a AS vacating Std 10 Create aniattifact coi E a a a Soh 11 Ui E Ea hen eo saka ar delay ah aie we a Dt ote a 12 Update an artifact
141. sion gt lt name gt REJECTED lt name gt lt automaticApprovalDecision gt lt DelegatedApprovalTemplate gt Example The following URL was sent to create an approval policy with two named approvers https lt host gt lt port gt csa rest organization 8a81818f3d1421e7013d1423635ae0003 approvalPolicy userIdentifier 90d96588360da0c701360da0f1d5f483 The following XML was sent in the request lt NamedApproverApprovalTemplate gt lt displayName gt My New Approval Template lt displayName gt lt approver gt lt userName gt ProjectManager lt userName gt lt approver gt lt approver gt lt userName gt BudgetManager lt userName gt lt approver gt lt minApprovalRequired gt 2 lt minApprovalRequired gt lt automaticApproval gt true lt automaticApproval gt lt automaticPeriodDuration gt 14 lt automaticPeriodDuration gt lt automaticApprovalDecision gt lt name gt APPROVED lt name gt lt automaticApprovalDecision gt lt NamedApproverApprovalTemplate gt The following XML was returned lt xml version 1 0 encoding UTF 8 standalone yes gt lt NamedApproverApprovalTemplate gt lt id gt 8a81818f3d1437e2013d17f249c30a0c lt id gt lt objectId gt 82a81818f3d1437e2013d17f249c30a0c lt objectId gt lt createdOn gt 2013 02 26711 19 47 397 08 00 lt createdOn gt lt updatedOn gt 2013 02 26T11 19 47 440 08 0 lt updatedOn gt lt createdBy gt lt createdBy gt lt updatedBy gt lt updatedBy gt
142. st subscriptions in the catalog 0 ec cece cece rr 71 HP Cloud Service Automation 4 10 Page 4 of 150 API Reference Contents Deprecation NoOtiCO escotes gs ann 71 Get subscription details 000000 e eee e cc roan aonan onroro noan 72 List instances in the catalog 2 220 cece cece c eee e rr 74 Deprecation Notite uuu as Sete da do eta o a es a 74 Get instance details lt oeri RATH ES LS cc A te 15 Retire an approval VEEE ae EEE ah AD eee AI See iu Tes O dle 75 Get resource subscription details 0 00000 0 76 Chapter 4 Export APT coco aie ea es Son pein a tt fos POSES NUK C2 YE TT W TETE POLAR TT 79 Chapter 6 Importzip API 0000000 0000 82 Deprecation Notice 0000 ccc cece rr 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 instance 5 89 Schedule lifecycle transition for service instance 0 00 e ec eee eee eeeeee eee 89 Chapter 9 Cogn AR aa aa ds ia 91 URIS TTT 91 ET ls E E syne Mn a SE bh Sod Sate et ple ala 91 Get userldentifier for user name with slash _ 2 22200 222 eee eee 92 Chapter 10 Notification API 94 RS artes A SAR e S aE 94 View list of notification objects 0000 0 rr 94 a lUe eT 1 00th Maidan deal a e toca the ld Mali 96 Cha
143. t name gt lt displayName gt Organization lt displayName gt lt disabled gt false lt disabled gt lt categoryType gt lt id gt 90d96588360da0c701360da0efe20059 lt id gt lt objectId gt 90d96588360da0c701360da0efe20059 lt objectId gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt name gt PARTY_TYPE lt name gt lt displayName gt Party Type lt displayName gt lt extensible gt false lt extensible gt lt categoryType gt lt partyType gt lt businessRole gt HP Cloud Service Automation 4 10 Page 104 of 150 API Reference lt id gt 90d96588360da0c701360da0f0020061 lt id gt lt objectId gt 90d96588360da0c701360da0f0020061 lt objectId gt lt created0n gt 2012 06 21T11 51 43 300 07 00 lt createdOn gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt description gt Consumer lt description gt lt iconUr1 gt csa images categories business_ role consumer png lt iconUr1 gt lt name gt CONSUMER lt name gt lt displayName gt Consumer lt displayName gt lt disabled gt false lt disabled gt lt categoryType gt lt id gt 90d96588360da0c701360da0effd0060 lt id gt lt objectId gt 90d96588360da0c701360da0effd0060 lt objectId gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt name gt BUSINESS ROLE lt name gt lt displayName gt Business Role lt displayName gt lt extensible gt false lt extensible gt lt categoryType gt lt businessRole gt lt
144. t serviceOffering gt lt subscriptionStatus gt lt subscriptionStatus gt lt initiatingServiceRequest gt lt initiatingServiceRequest gt lt ServiceSubscription gt lt ServiceSubscriptionList gt Get count of subscriptions for user Details URI user subscription count Gets the number of subscriptions for the user associated with userldentifier The resutls are grouped by subscription status Method GET Parameters userIdentifier lt user_id gt 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 userldentifier on page 91 for the steps required to get the userldentifier value Returns 200 Ok 401 Not authorized 500 Server exception HP Cloud Service Automation 4 10 Page 140 of 150 API Reference Get list of recent or expiring soon subscriptions for user Details URI Method Parameters Returns user subscription Returns a list of subscriptions for the user associated with userldentifier GET userIdentifier lt user_id gt 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 userldentifier on page 91 for the steps required to get the userldentifier value queryType expiringSoon recent Optional expiringSoon returns the
145. t Business Role lt displayName gt lt extensible gt false lt extensible gt lt categoryType gt lt businessRole gt lt organization gt lt organization gt lt OrganizationList gt View an organization Details URI Method organization lt organization_id gt View a list of organizations on page 100 to get the organization ID GET HP Cloud Service Automation 4 10 Page 102 of 150 API Reference URI Parameters Returns Example organization lt organization_id gt View a list of organizations on page 100 to get the organization ID userIdentifier lt user_id gt 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 userldentifier on page 91 for the steps required to get the userldentifier value scope base baseplusone Optional default is base If value is base then the object is returned If value is baseplusone then the base plus the first level children are returned Note that subtree is not a valid value for this API call detail required basic Optional default is basic See Values for the detail parameter on page 147 200 Ok 401 Not authorized 404 Not found 500 Server exception The following URL was sent https localhost 8444 csa rest organization 8a8181853810699a0138106dcdd00003 userIdentifier 82a8181853810699201381076
146. t extensible gt false lt extensible gt lt categoryType gt lt state gt lt artifactType gt lt id gt 90d96588360da0c701360da0eefcO 2a lt id gt lt objectId gt 90d96588360da0c701360da0eefc002a lt objectId gt lt createdOn gt 2012 06 21711 51 43 253 07 00 lt createdOn gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt description gt Organization lt description gt lt iconUr1 gt csa images categories artifact_type organization png lt iconUr1 gt lt name gt ORGANIZATION lt name gt lt displayName gt Organization lt displayName gt lt disabled gt false lt disabled gt lt categoryType gt lt id gt 90d96588360da0c701360da0eeb40017 lt id gt lt objectId gt 90d96588360da0c701360da0eeb40017 lt objectId gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt name gt ARTIFACT_TYPE lt name gt lt displayName gt Artifact Type lt displayName gt lt extensible gt false lt extensible gt lt categoryType gt lt artifactType gt lt disabled gt false lt disabled gt lt partyType gt lt id gt 90d96588360da0c701360da0eff1005d lt id gt lt objectId gt 90d96588360da0c701360da0eff1005d lt objectId gt lt createdOn gt 2012 06 21711 51 43 293 07 00 lt createdOn gt lt isCriticalSystemObject gt true lt isCriticalSystemObject gt lt description gt Organization lt description gt lt iconUr1 gt csa images categories party_type organization png lt iconUr1 gt lt name gt ORGANIZATION l
147. t want to load the base service instances when retrieving its service blueprint Service instances are artifacts and are associated through a collection reference with its blueprint Full All fields except for artifacts that are part of a containment relationship Retrieval of the internal artifacts is controlled by the scope parameter Using this option has a performance impact See Template option because this option also returns artifact collection references Note Some API calls do not support all possible values for this parameter HP Cloud Service Automation 4 10 Page 147 of 150 Chapter 18 Values for the scope parameter The scope parameter has the following values e Base Retrieves the root entity of the artifact including all required attributes e Baseplusone In addition to Base retrieves all first level child artifacts e Subtree In addition to Base retrieves all its descendants Using this option could have a performance impact because the information being retrieved can be very large e View Retrieves only those attributes defined for the view specified in the detail parameter HP Cloud Service Automation 4 10 Page 148 of 150 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 API Refer
148. tMessageList gt HP Cloud Service Automation 4 10 Page 84 of 150 Chapter 7 Import_result API Usethis 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 lt host gt lt port gt csa rest Details URI import_result lt importResultRecord_id gt importResultRecord IDs are returned by the Import API on page 79 Import API on page 79 Method GET Parameters userIdentifier lt user_id gt Required the user ID you want to use as credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier value format HTML Optional returns results as HTML rather than the default XML Returns 200 Ok 400 Bad request 404 Not found 500 Server exception Example The following URL was sent https lt host gt lt port gt csa rest import result ea933ec5 ad7b 42b6 b47c 965ff76f769 3 userldentifier 90d96588360da0c701360daof1d5f483 The following XML was returned lt ImportResult gt lt importResultLogEntry gt lt limit gt 0 lt limit gt lt artifactDescription gt SO ONE lt artifactDescription gt lt artifactDisplayName gt SO ONE lt artifactDisplayName gt lt artifactName gt SO_ONE_February 11 2013 7 08 05 PM UTC lt artifactName gt lt artifactType gt SERVICE_OFFERING lt artifactType gt HP Cloud Service Automation 4 10 Page 85 of 150 API Refe
149. t_id gt GET artifact lt artifact_id gt PUT artifact lt artifact_id gt DELETE artifact fastview lt artifact_ GET id gt artifact lt artifact_ GET id gt resolveProperties Group URI artifact lt organization_ id gt group artifact lt organization_ id gt group HP Cloud Service Automation 4 10 Method GET POST Parameters userldentifier userldentifier scope detail view userldentifier scope view userldentifier userldentifier view userldentifier propertyName Description Create an artifact on page 11 View an artifact on page 12 Update an artifact on page 14 Delete an artifact on page 17 Retrieve a predefined view for an artifact on page 17 Retrieve resolved properties for an artifact on page 19 Parameters Description userldentifier List active groups associated with an organization on page 22 userldentifier Add groups to an organization on page 23 Page 9 of 150 API Reference URI Method Parameters Description artifact lt organization_ PUT userldentifier Update group display name id gt group lt grou_id gt distinguished name on page 25 artifact lt organization_ DELETE userldentifier Delete or disassociate group from an id gt group lt group_id gt organization on page 26 Resource Provider URI Method Parameters Description artifact GET userldentifier artifactType List resource providers on page 27 Service Offering
150. te multiple service requests Details URI user multipleRequest delete Method POST Parameters userIdentifier lt user_id gt Required the user ID you want to use as credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier value Returns 200 Ok Indicates the REST call executed without error See XML return content for whether all specified requests were deleted 401 Not authorized 404 Object not found 500 Server exception A request can only be deleted if its stateis APPROVED DENIED or CANCELED HP Cloud Service Automation 4 10 Page 134 of 150 API Reference Example Use the following URL https lt host gt lt port gt csa rest user multipleRequest delete userIdentifier 90d965c0379fd06601379fd192b30ee6 The following XML was sent in the request lt ServiceRequestList gt lt ServiceRequest gt lt id gt 90e72e283b05afF1013b0b2c015103a4 lt id gt lt catalogItem gt lt catalog gt lt id gt 90d965c0379fd86601379fd193620f05 lt id gt lt catalog gt lt catalogItem gt lt ServiceRequest gt lt ServiceRequest gt lt id gt 90e72e283b05aff1013b0b2b43fc0356 lt id gt lt catalogltem gt lt catalog gt lt id gt 90d965c0379fd86601379fd193620f085 lt id gt lt catalog gt lt catalogItem gt lt ServiceRequest gt lt ServiceRequestList gt The following XML was returned in the response The count value indicates the number of serv
151. tion gt lt requestedAction gt lt actionInstance gt lt id gt 90 cec3aQ3a667c69013a9331a2800070 lt id gt lt createdOn gt 2012 10 11722 04 05 248 07 00 lt createdOn gt lt updatedOn gt 2012 10 11722 04 15 152 07 00 lt createdOn gt lt action gt lt action gt lt processInstance gt lt processInstance gt lt actionInstanceState gt lt actionInstanceState gt lt context gt 90cec3a0323667c69013a9331365f3a54 lt context gt lt callbackBean gt requestPorcessorActionCallbackHandler lt callbackBean gt lt callbackPending gt false lt callbackPending gt lt status gt lt status gt lt actionInstanceReturnCode gt lt actionInstanceReturnCode gt lt archive gt false lt archive gt lt actionInstance gt lt ServiceRequest gt lt ServiceRequestList gt List active requests for user Details URI user myrequest Method GET HP Cloud Service Automation 4 10 Page 130 of 150 API Reference URI Parameters Returns Examples user myrequest userIdentifier lt user_id gt 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 userldentifier on page 91 for the steps required to get the userldentifier value scope base view Optional default is base detail basic Optional The only valid value is basic sbmitter lt user_name gt Required user name must be valid and is
152. uest on id gt request lt request_id gt cancel page 63 catalog lt catalog_ DELETE userldentifier Retire a request on id gt request lt request_id gt page 63 Approval An approval is created when the approval manager approves a request URI Method Parameters Description catalog lt catalog_ GET userldentifier scope List approvals in the catalog id gt approval detail approver on page 64 returnRetired catalog lt catalog_ GET userldentifier scope Get approval details on page id gt approval lt approval_ detail 65 id gt catalog lt catalog_ PUT userldentifier Update approval decision id gt approval lt approval_ using an extemal approval id gt system on page 65 catalog lt catalog_ DELETE userldentifier Retire an approval on page 75 id gt approval lt approval_ id gt HP Cloud Service Automation 4 10 Page 45 of 150 API Reference URI Method Parameters Description catalog lt catalog_ PUT userldentifier Update approval decision id gt approval lt approval_ using CSA approval process id gt approver on page 66 Approval policy URI Method Parameters Description catalog lt catalog_id gt policy lt policy_ POST userldentifier Update catalog approval id gt setC atalogApprovalPolicy policies on page 68 catalog lt catalog_id gt policy lt policy_ POST userldentifier Update service offerings id gt setSOApprovalPolicy approval policy on page 69 Subscription A subscription is cr
153. urce offering type XMLs Artifact relationship XMLs Icon used for customizing component palette service component types and templates Manifest XML Example The following URL was sent to export a catalog https lt host gt lt port gt csa rest export 8a81818f3d02fb7e013d0308894a0004 userIdentifier 90d96588360da0c701360da0f1d5f483 The following response headers were returned and include the name of the downloaded archive zip file CATALOG QA Org _Catalog_8a81818f3d02fb7e013d0308894a0004 zip Status Code 209 OK Cache Control must revalidate post check pre check Content Disposition attachment filename CATALOG QA Org Catalog 8a81818f3d02fb7 e013d0308894a0004 Content Type application zip charset UTF 8 Date Tue 26 Feb 2013 00 09 36 GMT Expires Pragma public Server Apache Coyote 1 1 Transfer Encoding chunked content transfer encoding binary HP Cloud Service Automation 4 10 Page 78 of 150 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 lt host gt lt port gt csa rest Details URI import Method POST HP Cloud Service Automation 4 10 Page 79 of 150 API Reference URI Parameters Returns import userIdentifier lt user_id
154. user s subscriptions that will expire within the next 30 days and recent returns the last five subscriptions initiated by the user 200 Ok 401 Not authorized 500 Server exception Delete multiple subscriptions Details URI Method Parameters Returns Example user multipleSubscription delete POST userIdentifier lt user_id gt Required the user ID you want to use as credentials for this API call See Get userldentifier on page 91 for the steps required to get the userldentifier value 200 Ok Indicates the REST call executed without error See XML return content for whether all specified subscriptions were deleteed 401 Not authorized 404 Object not found 500 Server exception Use the following URL HP Cloud Service Automation 4 10 Page 141 of 150 API Reference https lt host gt lt port gt csa rest user multipleSubscription delete userIdentifier 90d965c0379fd06601379fd192b30ee6 A The following XML was sent in the request lt ServiceSubscriptionList gt lt ServiceSubscription gt lt id gt 90e72e283b05aff1013b0b2c015103234 lt id gt lt catalogItem gt lt id gt 90 cef5de3c63429F013c6489245be9a2 lt id gt lt catalog gt lt id gt 90d965c0379fd86601379fd193620f05 lt id gt lt catalog gt lt catalogItem gt lt ServiceSubscription gt lt ServiceSubscription gt lt id gt 90e72e283bos5aff1013bab2b43fc0356 lt id gt lt catalogltem gt lt id gt 90cef5de3c63429f013c64892
155. wing the use cases are allowed e With view propertyinfo specifying property_action_ merge will merge the properties specified in the request body with the existing process instance properties e With view processinstancestate specifying action merge will merge the state information specified in the request body with the existing process instance state ProcessInstance VO Updated Processlnstance VO 200 Ok 401 Not authorized 404 Not found 500 Server exception Process instance state processInstanceState values INITIALIZED PENDING READY ACTIVE COMPLETED ERROR CANCELED Process instance return code processReturnCode values SUCCESS FAILURE RUNNING TIMEOUT HP Cloud Service Automation 4 10 Page 123 of 150 API Reference Examples The following was sent to update propertyinfo of a process instance https lt host gt lt port gt csa rest processinstances 90d9652b362d4ecd01362d4fb7be0f71 userIdentifier 90d9652b362d4ecd01362d4ef51e00258view propertyinfogscope view epr operty_action_ merge The following XML was sent in the request to update a property lt ProcessInstance gt gt lt id gt 90d9652b362d4ecd01362d4fb7be0f71 lt id gt lt property gt lt name gt Property Name lt name gt lt valueType gt lt name gt STRING lt name gt lt valueType gt lt values gt lt value gt Hello World lt value gt lt values gt lt property gt lt ProcessInstance gt The
156. zations e SERVICE_CONSUMER For Provider type organizations CONSUMER_SERVICE_ADMINISTRATOR SERVICE BUSINESS MANAGER SERVICE DESIGNER CSA ADMIN RESOURCE SUPPLY MANAGER SERVICE_OPERATIONS_MANAGER Example The following URL was sent https lt host gt lt port gt csa rest artifact 8a81818f3d1421e7013d142363520003 group u serIdentifier 90d96588360da0c701360da0f1d5f483 The following XML was sent lt GroupList gt lt group gt lt displayName gt My Group Name lt displayName gt lt distinguishedName gt cn TestConsumer ou ConsumerGroup ou CSAGroups lt distinguishedName gt lt role gt lt name gt SERVICE_CONSUMER lt name gt lt role gt lt group gt HP Cloud Service Automation 4 10 Page 23 of 150 API Reference lt group gt lt displayName gt Another Group Name lt displayName gt lt distinguishedName gt cn TestConsumer2 ou ConsumerGroup ou CSAGroups lt distinguishedName gt lt role gt lt name gt SERVICE_CONSUMER lt name gt lt role gt lt group gt lt GroupList gt The following XML was returned lt xml version 1 0 encoding UTF 8 standalone yes gt lt GroupList gt lt count gt 2 lt count gt lt limit gt 2 lt limit gt lt group gt lt isCriticalSystemObject gt false lt isCriticalSystem0bject gt lt name gt My Group Name lt name gt lt displayName gt My Group Name lt displayName gt lt disabled gt false lt disabled gt lt distinguishedName gt c

HP CloudSystem Enterprise CLI Reference Guide

Contents

Download Pdf Manuals

Related Search

Related Contents