Integration Guides › Web Service API Reference Guide › Valid Web API Objects › cat Object › list Method (cat Object)

list Method (cat Object)

Description

Retrieve list of global catalog

Syntax

/api/v1/cat/list?vdc=controller-name 

Arguments

vdc

Name of the target virtual data center

Transaction Type

synchronous

Request Type

GET

Examples

Retrieve a list of the catalogs.

GET http://192.168.123.200/api/v1/cat/list?vdc=mygrid 

Sample Output

XML:

<opt>
   <catalog dynamic>
      <description></description>
   </catalog dynamic>
   <catalog filer>
      <description></description>
   </catalog filer>
   <catalog system>
      <description></description>
   </catalog system>
   <catalog user>
      <description></description>
   </catalog user>
</opt> 

JSON:

{
   "catalog user" : {
      "description" : ""
   },
   "catalog filer" : {
      "description" : ""
   },
   "catalog system" : {
       "description" : ""
   },
   "catalog dynamic" : {
      "description" : ""
   }
} 

HTTP Error Codes

404

Entity vdc mygrid not found - A VDC name was specified that is not configured in the WS_API application.

info Method (cat Object)

Description

Retrieve information for a local application or a global catalog

Syntax

/api/v1/cat/info?cat=catalog&vdc=controller-name 

Arguments

cat

Name of the catalog

vdc

Name of the target virtual data center

Transaction Type

synchronous

Request Type

GET

Examples

Retrieve information for catalog test.

GET http://192.168.123.200/api/v1/cat/info?cat=/test&vdc=mygrid 

Sample Output

XML:

<catalog>
   <name>test</name>
   <description></description>
   <total_classes>0</total_classes>
   <total_diskspace>0</total_diskspace>
</catalog>

JSON:

{
    "total_classes" : "0",
   "name" : "test",
   "description" : "",
   "total_diskspace" : "0"
} 

HTTP Error Codes

404

Entity vdc mygrid not found - A VDC name was specified that is not configured in the WS_API application.

400.4

Missing required arguments (cat). - Argument cat=catalog missing in the request.

404.1

'test' is not a valid catalog - Invalid catalog specified in the request.