CLI Reference Guide

Get catalog details
Details
URI
/catalog/<catalog_id>
Use "List catalogs" on page 46 to get the catalog ID.
Method
GET
Parameters
userIdentifier=<user_id>
Required; the user ID you want to use as credentials for this API call. This user
should be a consumer user who has the necessary permissions for the data you
want to work with. See "Get userIdentifier" on page 88 for the steps required to
get the userIdentifier 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 139.
Some API calls do not support all possible values for this parameter.
Returns
200 - Ok
401 - Not authorized
404 - Not found
500 - Server exception
Examples
Use the following URL:
https://<host>:<port>/csa/rest/catalog/402895e566cb32ss0136cb831752000f
?userIdentifier=90d9652b35f46a930135f35b327e00a0&scope=base&detail=required
The following XML was returned in the response:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Catalog>
<id>402895e345cb67dd0136ss331752000f</id>
<objectId>402895e345cb67dd0136ss331752000f</objectId>
<isCriticalSystemObject>false</isCriticalSystemObject>
<name>Catalog_Consumer_A</name>
<displayName>Consumer Catalog A</displayName>
<state>
<id>90d96567360da0c701360ss0ef470038</id>
<objectId>90d96567360da0c701360ss0ef470038</objectId>
<isCriticalSystemObject>true</isCriticalSystemObject>
HP Cloud Service Automation (4.00) Page 48 of 141
APIReference
Contents