Locks an object. Remember that the child objects under this object will be automatically locked. User can modify (set or remove) only locks which has been set by him or on objects which has not set any lock.
If at least one object is already locked by another user than the user is forbidden to do lock, the return code is 403 Forbidden, Object already locked, without any other info.
To get more information about already locked objects can be used GET method, see Check if an object is locked
When lock operation request has succeeded api call returns standard return code 200 OK. When a PUT or POST operation on any particular object is performed (eg: PUT objects/<object_id>) then presense of the the lock is checked only on this particular object & the lock is not checked on its parent or children objects. Selection lock At selection object lock (eg: PUT objects/{selectionId}/locks) the elements belonging to the selection will be locked. Selection lock doesn't support children locks, api call with children lock parameter (default is withChildren=true) returns code 400 Bad Request. If at least one element object (by selection) is locked by another user and the API call doesn't specify query parameter asAdmin=true (default is asAdmin=false), than the user is forbidden to do selection lock, the return code is 403 Forbidden. If selection contains at least one non-existent element object the return code is 403 Forbidden.
In the In following example case, we have an selection object : '1' with children '1a' and '1b':
{
id: 1,
children:
[
{id: 1a, locked: {…}},
{id: 1b}
]
} this means selection object has 2 children, one of them is already locked (the one with id: 1a).
Result of the following call: PUT /v2/my-slug/objects/1/locks is: If - 403 Object already locked, when object id:1a is locked
with another user as - with another user as user which is making the call
PUT /v2/my-slug/objects/1/locks return 403 Object already locked, without - .
Result doesn't contains any other info
- .
To get more details about locking info can be called GET /v2/my-slug/objects/1/locks which will return
with status code 200 object which holds info about who actually locks
Return 200 { - objects e.g. :
{
{ id: 1a, locked: {userId= ….…}}
}
If 1a - 200 Status OK, when 1a objects is locked
with - by user which is making the call
PUT /v2/my-slug/objects/1/locks return 200 all objects - .
All objects - id:1, id:1a, id:1b are now
locked with - lockedwith user which is making the call
|