Get iModel Locks - iModels

REST API Overview

Reference

iModels

Download API definition:

GET https://qa-api.bentley.com/imodels/{id}/locks[?$skip][&$top][&briefcaseId][&lockLevel]

Queries locks of the iModel. 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.

Paging

Page size refers to total size of returned objectIds throughout all returned instances. If several Lock instances are returned that does not necessarily mean that instance is complete and more objectIds might be returned for that specific instance in a different page.

Authentication

Requires Authorization header with valid Bearer token for scope itwin-platform.

For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.

Authorization

User must have imodels_webview permission assigned at the iModel level. If iModel Role permissions at the iModel level are configured, then user must additionally have at least imodels_webview permission assigned at the iTwin level. If permissions at the iModel level are not configured, then user must have imodels_webview permission assigned at the iTwin level.

Alternatively the user should be an Organization Administrator for the Organization that owns a given iTwin the iModel belongs to.

For more information please refer to Account Administrator documentation section on Access Control API documentation page.

Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit Rate limits and quotas page.

Request

Request parameters

Yes

iModel id

$skip

The $skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. E.g. to return items from the collection starting at the third place provide the following query: $skip=2.

$top

The $top query option requests the number of items in the queried collection to be included in the result. E.g. to return only first collection item provide the following query: $top=1. When $top parameter is not provided default is set to 100. $top value cannot exceed 1000.

briefcaseId

The briefcaseId query option allows users to filter Locks by their briefcaseId property and query only Locks of a single Briefcase.

lockLevel

The lockLevel query option allows users to filter Locks by their lock level property. To return lockedObjects that are exclusively locked, provide keyword e.g.: lockLevel=exclusive. Valid values for this parameter are 'exclusive' or 'shared'.

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

Setting to application/vnd.bentley.itwin-platform.v2+json is recommended.

Response

Response 200 OK

json

{
    "locks": [{
            "briefcaseId": 2,
            "lockedObjects": [{
                    "lockLevel": "shared",
                    "objectIds": ["0x1", "0x2", "0xab"]
                },
                {
                    "lockLevel": "exclusive",
                    "objectIds": ["0x3", "0x4", "0xac"]
                }
            ]
        },
        {
            "briefcaseId": 3,
            "lockedObjects": [{
                "lockLevel": "shared",
                "objectIds": ["0x12", "0x21", "0xff"]
            }]
        }
    ],
    "_links": {
        "self": {
            "href": "https://api.bentley.com/imodels/5e19bee0-3aea-4355-a9f0-c6df9989ee7d/locks?$skip=0&$top=100"
        },
        "prev": {
            "href": "https://api.bentley.com/imodels/5e19bee0-3aea-4355-a9f0-c6df9989ee7d/locks?$skip=0&$top=100"
        },
        "next": {
            "href": "https://api.bentley.com/imodels/5e19bee0-3aea-4355-a9f0-c6df9989ee7d/locks?$skip=100&$top=100"
        }
    }
}

Response 401 Unauthorized

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.

json

{
    "error": {
        "code": "HeaderNotFound",
        "message": "Header Authorization was not found in the request. Access denied."
    }
}

Response 404 Not Found

Specified iModel was not found.

json

{
    "error": {
        "code": "iModelNotFound",
        "message": "Requested iModel is not available."
    }
}

Response 422 Unprocessable Entity

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)

json

{
    "error": {
        "code": "InvalidiModelsRequest",
        "message": "Cannot get Locks.",
        "details": [{
            "code": "InvalidValue",
            "message": "'-1' is not a valid '$skip' value. '$skip' must be a non-negative integer.",
            "target": "$skip"
        }]
    }
}

Response 429 Too many requests

This response indicates that the user has sent too many requests in a given amount of time.

json

{
    "error": {
        "code": "TooManyRequests",
        "message": "More requests were received than the subscription rate-limit allows."
    }
}

Response headers

retry-after

The number of requests exceeds the rate-limit for the client subscription.

Definitions

Lock

Representation of a Lock.

briefcaseId

Int32

Briefcase Id.

lockedObjects

LockedObjects[]

An array of locked objects.

Locks Response

List of Locks.

locks

Lock[]

List of locks.

_links

PagingLinks

Contains the hyperlinks to the previous and next pages of results.

Locked Objects lockLevel

Indicates the lock level. Possible values: 'none' - used for releasing already acquired locks, 'shared' - multiple Briefcases can acquire a shared lock on the same object, 'exclusive' - only one Briefcase can acquire an exclusive lock on a given object.

none

String

shared

String

exclusive

String

Locked Objects

Contains a list of locked object ids and their lock level.

Locked Objects lockLevel

LockedObjects-lockLevel

objectIds

String[]

List of locked object ids. Allowed values are hexadecimal strings with '0x' prefix.

Link

Hyperlink container.

href

String

Hyperlink to the specific entity.

Paging Links

URLs for redoing the current request, getting to the previous or next page of results, if applicable.

self

Link

URL for redoing the current request.

Link

URL for getting the previous page of results.

Link

URL for getting the next page of results.

Error

Contains error information.

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String, null

The target of the error.

Error Response

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.

error

Error

Error information.