This page is under construction
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
URL: https://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/locks
Example:https://api-stage.bimplus.net/v2/bimplus/objects/770dbe31-8df0-441a-92de-b464bfdfa0e8/locks
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
user |
will be ignored |
string |
The user who performs the lock operation |
objects |
will be ignored |
string |
The object ids which are locked. Remember that the child objects under this object will be automatically locked. |
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
Get info about a setting
URL: https://api-stage.bimplus.net/v2/application/settings/<setting_id>
Example:https://api-stage.bimplus.net/v2/application/settings/c47b737c-6727-4832-bcd1-57ead714ae34
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{
"key": "AutoLoadLastModel",
"value": "Yes",
"updated": "2015-08-19T00:04:16.387",
"id": "c47b737c-6727-4832-bcd1-57ead714ae34"
}
Delete a setting
URL: https://api-stage.bimplus.net/v2/application/settings/<setting_id>
Example:https://api-stage.bimplus.net/v2/application/settings/c47b737c-6727-4832-bcd1-57ead714ae34
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
