Previous Topic: list Method (class Object)Next Topic: unlock Method (class Object)

Integration Guides › Web Service API Reference Guide › Valid Web API Objects › class Object › lock Method (class Object)

lock Method (class Object)
Description

Lock a class

Syntax
/api/v1/class/lock?class=class&pwd=password&vdc=controller-name
Arguments
class

Name of the class to be locked

pwd

Password

vdc

Name of the target virtual data center

Transaction Type

synchronous

Request Type

GET

Examples

Lock class /test:IN. 

GET http://192.168.123.200/api/v1/class/lock?class=/test:IN&pwd=password&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 (class). - Argument class=entity missing in the request.

400.4

Missing required arguments (pwd). - Argument pwd=password missing in the request.

404.1

Global catalog 'test' not found. - Invalid catalog specified in the request.

404.1

Class 'LUX' not found. - Invalid class specified in the request.

Note: The password specified to lock a class is required to unlock the class. When a class is locked, the following operations cannot be executed by non-administrators: