lock

Description

The lock prevents another user from changing an entity.

URL

/qcbin/rest/domains/{domain}/projects/{project}/{entity collection}/{Entity ID}/lock

Remarks

For details of which resources support locking, see Version Control and Locking Resources

See Update an Entity.

HTTP Methods

GET: Returns the lock status and owner .

PUT: N/A

DELETE: Removes the lock.

POST: Creates the lock and returns the entity description. Do not pass data with the POST.

Media Type
GET
PUT
DELETE
POST
application/xml
check
-
check
check
application/json
-
-
-
-

Returns

One of the HTTP Return Codes.

GET returns an XML string compliant with the LockStatusEntity Schema.

POST returns an XML string compliant with the Entity Schema that describes the locked entity.

DELETE  does not return a response body.

Examples

GET lock XML

See Also

Update an Entity
check-out
check-in










_HP_HTML5_bannerTitle.htm