Acquires requested locks on specified objects. Lock - the right to modify a specific type of data within the iModel. For more information on Locks see working with Locks via iTwin.js client libraries.
Note: Lock types have been removed for this API and should be ignored.
Object ids Limit: Currently there can be at most 1000 object ids in a single request.
Authorization header with valid Bearer token for scope
For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.
To release any Locks (set
none) user must have
imodels_manage permission assigned at the iModel level. If permissions at the iModel level are not configured, then user must have
imodels_manage permission assigned at the iTwin level. To acquire or realese Locks that the user owns
imodels_write permission is enough.
Alternatively the user should be an Organization Administrator for the Organization that owns a given iTwin the iModel belongs to.
An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities Licensing, Cloud, and Web Services wiki page.
All iTwin Platform API operations have a rate limit. For more documentation on that visit Rate limits and quotas page.
This response indicates that request lacks valid authentication credentials. Access token might not been provided, issued by the wrong issuer, does not have required scopes or request headers were malformed.
User is not authorized to update Locks.
Specified iModel, Briefcase, Lock or Changeset was not found.
Locks are already owned by another briefcase and cannot be acquired, locks have been updated in a newer changeset or the iModel is not initialized.
Indicates that the request payload contains too many object ids.
The 422 (Unprocessable Entity) status code indicates that the request cannot be processed by the server due to a client error (e.g. malformed request syntax)
Representation of a Lock.
Container for Lock object.
Properties of locks to be updated.
Contains a list of locked object ids and their lock level.
Returned in some specific cases from Locks request and contains additional information about the object ids that caused the error.
Returned when acquiring Locks fails due to conflicts and contains additional information about the conflicting Locks.
Contains information about a conflicting lock.
Contains error information.
Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.