Develop > Application Programming Interface > Deprecated APIs > List instances in the catalog

List instances in the catalog

Deprecation Notice

The GET /catalog/<catalog_id>/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/<catalog_id>/instance
Use /catalog 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.

requestor=<user_name>
    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://<host>:<port>/csa/rest/catalog/402895e33732af18013732b6f435006b/ instance?userIdentifier=90d9652b67ss6a930135f35b327e00a0

The following XML was returned:


<ServiceInstanceList>
     <count>6</count>
     <limit>0</limit>
     <ServiceInstance>
        <id>90d957ea3806fa7e01380f957d11070a</id>
        <name>MYSD_June 5, 2012 5:19:51 PM UTC</name>
        <displayName>MYSD</displayName>
        <state></state>
        <serviceInstanceState>...</serviceInstanceState>
        ...
     </ServiceInstance>
     ...
<ServiceInstanceList>