Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • 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 ?useclientidclientlock=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

...

Deck of Cards
idbimDeleteLock
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: objects/<object_id>/locks

URLhttps://api-stage.bimplus.net/v2/objects/<object_id>/locks 

Example:https://api-stage.bimplus.net/v2/bimplus/objects/770dbe31-8df0-441a-92de-b464bfdfa0e8/locks

This call also supports query paramaters "withChildren" and "asAdmin" described here

Card
labelHTTP Method
 DELETE
Card
labelDescription
 Removes the lock from this object.
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK