Page History

...

Deck of Cards

id	bimCreateLock

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>/locks

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.

Card

label	HTTP Method

PUT

Card

label	Description

Locks 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. If user is forbidden to do the lock ( because of other lock or locks ), the returtn code is 403 Forbidden.

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

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

Anchor

	createLockOptions
	createLockOptions

...

Deck of Cards

id	bimGetLocks

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>/locks

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

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

Card

label	HTTP Method

GET

Card

label	Description

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

[
    {
        "user": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "jayaraj.purushothaman@gmail.com"
        }
        "clientid" : "132ecbe-2ac5-4ae1-945d-d38fc3bc1e82",
        "objects": [
            "55c42bbd-7577-4928-aa91-0938ee408a86"
        ]
    }
]

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 12

New Version 13

Key