CLI Reference Guide

URI
/artifact/<artifact_id>
Parameters
userIdentifier=<user_id>
Required; the user ID you want to use as credentials for this API call. See "Get
userIdentifier" on page 88 for the steps required to get the userIdentifier value.
scope=[base|baseplusone|subtree|view]
Optional; default is base. If value is base, then the object is returned. If value is
baseplusone, then the object and its first level children are returned. 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 139
Note: Some API calls do not support all possible values for this parameter.
detail=FULL, even as the 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=<view_type>
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.
Returns
200 - Ok
401 - Not authorized
500 - Server exception
Examples
Use the following URL:
https://<host>:<port>/csa/rest/artifact/90e72e4f3b00a69e013b0bf7ed55002e?userIde
ntifier=<user_id>
The following XML was returned in the response:
<ResourceEnvironment>
<id>90e72e4f3b00a69e013b0bf7ed55002e</id>
<objectId>90e72e4f3b00a69e013b0bf7ed55002e</objectId>
<createdOn>2012-11-16T17:24:55.765-08:00</createdOn>
<updatedOn>2012-11-16T17:24:55.765-08:00</updatedOn>
<createdBy>
<id>90d96588360da0c701360da0f1d5f483</id>
<objectId>90d96588360da0c701360da0f1d5f483</objectId>
<isCriticalSystemObject>true</isCriticalSystemObject>
<name>admin</name>
<displayName>admin</displayName>
<disabled>false</disabled>
HP Cloud Service Automation (4.00)Page 13 of 141
APIReference
Contents