Develop > Application Programming Interface > Legacy APIs > Catalog API > List offerings in the catalog

List offerings in the catalog

Details

URI /catalog/<catalog_id>/offering
Use List catalogs 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 for the steps required to get the userIdentifier 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.

restrict=[true|false]

 Optional; default is true. If the value is true, then the output fields of the REST response are restricted. By default, the following fields are not displayed: createdBy, updatedBy, createdOn, updatedOn, description, iconUrl, and categoryType. If the value is false, then the output fields are displayed.

For more information, see Values for the restrict parameter
Returns

200 - Ok
401 - Not authorized
404 - Not found
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://<host>:<port>/csa/rest/catalog/402895e33732af18013732b6f435006boffering?userIdentifier=90d9652b67ss6a930135f35b327e00a0

The following XML was returned in the response:


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ServiceOfferingList>
  <count>3</count>
  <limit>0</limit>
  <ServiceOffering
    <id>90e763db3dd1a9a4013dd1e16aa16c95</id>
    <objectId>90e763db3dd1a9a4013dd1e16aa16c95</objectId>
    <createdOn>2013-04-03T14:50:43.873-07:00</createdOn>
    <updatedOn>2013-04-03T14:50:43.873-07:00</updatedOn>
    <isCriticalSystemObject>false</isCriticalSystemObject>
    <description>3 Level Option for testing service offerings Integration Service Offering</description>
    </artifactType>
    <serviceBlueprint>
    <detailedDescription>3 Level Option for testing service offerings Integration Service Offering</detailedDescription>
    <iconUrl>/csa/images/library/compliance.png</iconUrl>
    <name>ServiceOffering for ApprovalPolicy</name>
    <displayName>ServiceOffering for ApprovalPolicy</displayName>
    <state> … </state>
    <artifactType> … </artifactType>
    <disabled>false</disabled>
    <offeringState> … </offeringState>
  </ServiceOffering>
  <ServiceOffering> … </ServiceOffering>
  <ServiceOffering> … </ServiceOffering>
</ServiceOfferingList>

Send Help Center feedback