Develop > Application Programming Interface > Legacy APIs > Catalog API > List catalogs

List catalogs

Details

URI /catalog
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|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. Some API calls do not support all possible values for this parameter.

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 - Object not found
500 - Server exception

Examples

Use the following URL:

https://<host>:<port>/csa/rest/catalog ?userIdentifier=90d9652b35f46a930135f35b327e00a0&scope=base&detail=basic

The following XML was returned in the response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<CatalogList>
    <count>12</count>
    <limit>0</limit>
    <catalog>
        <id>402895e566cb32ss0136cb831752000f</id>
        <objectId>402895e566cb32ss0136cb831752000f</objectId>
        <createdOn>2012-04-19T09:23:04.913-06:00</createdOn>
        <updatedOn>2012-04-19T09:23:04.913-06:00</updatedOn>
        <isCriticalSystemObject>false</isCriticalSystemObject>
        <description>Default catalog for the organization.</description>
        <name>consumer_catalog_a</name>
        <displayName>Consumer Catalog A</displayName>
        <state>
            <id>90d96588364da0c701370da0ss320037</id>
            <objectId>90d96588364da0c701370da0ss320037</objectId>
            <createdOn>2012-04-19T09:22:25.943-06:00</createdOn>
            <isCriticalSystemObject>true</isCriticalSystemObject>
            <description>Active</description>
            <iconUrl>/csa/images/categories/artifact_state/active.png</iconUrl>
            <name>ACTIVE</name>
            <displayName>Active</displayName>
            <disabled>false</disabled>
            <categoryType>
                <id>90d96588364da0c701370da0ss320038</id>
                <objectId>90d96588364da0c701370da0ss320038</objectId>
                <isCriticalSystemObject>true</isCriticalSystemObject>
                <name>ARTIFACT_STATE</name>
                <displayName>Artifact State</displayName>
                <extensible>false</extensible>
            </categoryType>
        </state>
        <artifactType>
            <id>90d96588364da0c701370da0ss320039</id>
            <objectId>90d96588364da0c701370da0ss320039</objectId>
            <createdOn>2012-04-19T09:22:26.050-06:00</createdOn>
            <isCriticalSystemObject>true</isCriticalSystemObject>
            <description>Catalog</description>
            <iconUrl>/csa/images/categories/artifact_type/catalog.png</iconUrl>
            <name>CATALOG</name>
            <displayName>Catalog</displayName>
            <disabled>false</disabled>
            <categoryType>
                <id>90d96588364da0c701370da0ss320030</id>
                <objectId>90d96588364da0c701370da0ss320030</objectId>
                <isCriticalSystemObject>true</isCriticalSystemObject>
                <name>ARTIFACT_TYPE</name>
                <displayName>Artifact Type</displayName>
                <extensible>false</extensible>
            </categoryType>
        </artifactType>
        <disabled>false</disabled>
    </catalog>
...
</CatalogList>

Send Help Center feedback