You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 20 Next »

Lock Service


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

Renew your license to continue

Your evaluation license has expired. Contact your administrator to renew your Composition license.

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)
  • If the user wants to perform the lock & unlock only on any particular client (say a Desktop Application like Allplan) then ?clientlock=true has to be specified during the locking/unlocking (Which if the user tries to unlock from another client it won't work) Please notice that, the user have to specify the client_id in the authorize call if he wants to use this particular functionality.
  • Normally, the objects have to be unlocked by the same person who has locked it. If the possibility to unlock an object locked by another user has to be given to the account owner or project admin, then ?asAdmin=true has to be specified during locking/unlocking

Check if an object is locked

Renew your license to continue

Your evaluation license has expired. Contact your administrator to renew your Composition license.

Delete a Lock

Renew your license to continue

Your evaluation license has expired. Contact your administrator to renew your Composition license.

  • No labels