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

create Method (cat Object)

Description

Create a new global catalog

Syntax

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

Arguments

cat

Name of the new catalog

vdc

Name of the target virtual data center

Transaction Type

synchronous

Request Type

GET

Examples

Create a catalog named /test.

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

Sample Output

XML:

<opt></opt>

JSON:

{} 

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. Only global catalogs can be created.

destroy Method (cat Object)

Description

Destroy a global or application catalog

Syntax

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

Arguments

cat

Name of the catalog to be destroyed

vdc

Name of the target virtual data center

Transaction Type

asynchronous

Request Type

GET

Examples

Destroy a catalog named /test.

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

Sample Output

XML:

<job>be805915-76b2-48c8-b8a0-b881cca66da6</job>

JSON:

{
   "job" : "be805915-76b2-48c8-b8a0-b881cca66da6"
} 

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.

Notes: To get the status of job, issue a /api/v1/job/info? request with the job_id returned above as the argument. For more information about how to obtain the job status, refer to the job object.