Versions Compared

Key

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

...

Deck of Cards
idbimCreateLock


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: objects/<object_id>/locks

URLhttps://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
labelHTTP Method
 PUT


Card
labelDescription

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.

Selection lock

At selection object lock (eg: PUT objects/{selectionId}/locks) the elements belonging to the selection will be locked.

Selection lock doesn't support children locks, call api with children lock parameter (default is withChildren=true) return code 400 Bad Request.

If at least one element object (by selection) is locked by another user and the API call doesn't specify parameter ?asAdmin=true (default is asAdmin=false), than the user is forbidden to do selection lock, the return code is 403 Forbidden.

If selection contains at least one non-existent element object the return code is 403 Forbidden.


Card
labelRequest


Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK



...