Page History

...

Lock Service

...

•  Lock an object
• Lock object with different possibilities (eg: Whether the children should be locked etc)
• Check if an object is locked
• Remove the lock

Lock Service

...

This API is used for locking objects. Please remember that the API has more possibilities like whether another person can unlock an object, whether the child object should be locked during locking etc

Lock an object

...

Deck of Cards
id bimPinUpdate
Card default true label URL / Resource / JSON Structure Resource:  applicationobjects/settings/<setting<object_id>/locks URL: https://api-stage.bimplus.net/v2/application<team_slug>/settingsobjects/<setting_id><object_id>/locks  Example:https://api-stage.bimplus.net/v2/applicationbimplus/settingsobjects/c47b737c770dbe31-67278df0-4832441a-bcd192de-57ead714ae34b464bfdfa0e8/locks JSON Structure:  (date) update date of the setting Name Mandatory / Optional Type Description iduser will be ignored string Name of the project key optional string Key(i.e name) of the setting. It should be unique. value optional string Value for the key The user who performs the lock operation objects update will be ignored string The object ids which are locked. Remember that the child objects under this object will be automatically locked. Card label HTTP Method  PUT Card label Description Update the value of a settingLocks an object. Remember that the child objects under this object will be automatically locked. When a PUT or POST operation on any particular object is performed (eg: PUT objects/<object_id>) then the lock is checked only on this particular object & the lock is not checked on its parent or children. Card label Request Code Block borderColor Green lang xml title Headers Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json Status: 200 OK Card label Response Code Block borderColor Green lang xml title Status Status: 200 OK Code Block borderColor Red lang xml title JSON [ { "keyuser": { "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed", "email": "AutoLoadLastModel"jayaraj.purushothaman@gmail.com" }, "value": "No" } Card label Response Code Block borderColor Green lang xml title Status objects": [ "55c42bbd-7577-4928-aa91-0938ee408a86", "770dbe31-8df0-441a-92de-b464bfdfa0e8" ] } ]

Anchor
createLockOptions createLockOptions

Lock object with different possibilities (eg: Whether the children should be locked etc)

Remember that PUT objects/<object_id>/locks automatically locks the child objects found under this particular object. But, if the user wants to lock only this particular object without locking its children then, he has to specify  ?withChildren=false (i.e objects/<object_id>/locks?withChildren=false)

...