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

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

[
    {
        "user": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "jayaraj.purushothaman@gmail.com"
        },
        "objects": [
            "55c42bbd-7577-4928-aa91-0938ee408a86",
            "770dbe31-8df0-441a-92de-b464bfdfa0e8"
        ]
    }
]

...

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 ?useclientid=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

...

Deck of Cards
id bimGetSettingInfobimGetLocks
Card default true label URL / Resource / JSON Structure Resource:  applicationobjects/settings/<setting<object_id>/locks URL: https://api-stage.bimplus.net/v2/application/objects/settings/<setting_id>/locks  Example:https://api-stage.bimplus.net/v2/applicationbimplus/settingsobjects/c47b737c770dbe31-67278df0-4832441a-bcd192de-57ead714ae34b464bfdfa0e8/locks Card label HTTP Method  GET Card label Description  Get details of a specified user setting Check if an object is locked or not. The response contains also the child objects which has been locked & info about the user who has locked it. Card label Request Code Block borderColor Green lang xml title Headers Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json Card label Response Code Block borderColor Green lang xml title Status Status: 200 OK Code Block borderColor Red lang xml title JSON [ { "keyuser": "AutoLoadLastModel",{ "valueid": "Yes71e0ac3b-fa49-e540-ac2f-8caff3dd72ed", "updatedemail": "2015-08-19T00:04:16.387"jayaraj.purushothaman@gmail.com" }, "idobjects": "c47b737c-6727-4832-bcd1-57ead714ae34" }

...

[ "55c42bbd-7577-4928-aa91-0938ee408a86" ] } ]

Anchor
deleteLock deleteLock

Delete a Lock

...

Deck of Cards
id bimDeleteSettingbimDeleteLock
Card default true label URL / Resource / JSON Structure Resource:  applicationobjects/settings/<setting<object_id>/locks URL: https://api-stage.bimplus.net/v2/application/objects/settings/<setting_id>/locks  Example:https://api-stage.bimplus.net/v2/applicationbimplus/settingsobjects/c47b737c770dbe31-67278df0-4832441a-bcd192de-57ead714ae34b464bfdfa0e8/locks Card label HTTP Method  DELETE Card label Description  Deletes a specified pin Removes the lock from this object. Card label Request Code Block borderColor Green lang xml title Headers Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json Card label Response Code Block borderColor Green lang xml title Status Status: 200 OK