Release iModel Locks Chunk - iModels

iModels

Download API definition:

POST https://dev-api.bentley.com/imodels/{id}/locks/release-chunk

Releases a chunk of locks for a specified briefcase.

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.

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.

To release any Locks 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 release 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.

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

iModelId

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Content-Type

Indicates request body content type. Supported media type is application/json.

Request body

Release Locks Chunk

briefcaseId

Int32

Yes

Briefcase Id for which to release locks.

changesetId

String, null

Changeset Id. Meant to identify the latest Changeset in which the locked object was updated. If this value points to an older Changeset than the value saved in the server acquiring locks will fail.

Example

json

{
    "briefcaseId": 2,
    "changesetId": "1f2e04b666edce395e37a795e2231e995cbf8349"
}

Response

Response 200 OK

json

{
    "isLastChunk": true
}

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 403 Forbidden

User is not authorized to release Locks chunk.

json

{
    "error": {
        "code": "InsufficientPermissions",
        "message": "The user has insufficient permissions for the requested operation."
    }
}

Response 404 Not Found

Specified iModel, Briefcase, Lock or Changeset was not found.

json

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

Response 409 Conflict

iModel is not initialized and modify operations are not allowed.

json

{
    "error": {
        "code": "iModelNotInitialized",
        "message": "iModel is not initialized."
    }
}

Response 415 Unsupported Media Type

This response indicates that the user has specified not supported media type in the request.

json

{
    "error": {
        "code": "UnsupportedMediaType",
        "message": "Media Type is not supported."
    }
}

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 release Locks chunk.",
        "details": [{
                "code": "InvalidValue",
                "message": "Provided 'briefcaseId' value is not valid. Expected a value of type 'integer'.",
                "target": "BriefcaseId"
            },
            {
                "code": "MissingRequiredProperty",
                "message": "Required property is missing.",
                "target": "BriefcaseId"
            },
            {
                "code": "InvalidRequestBody",
                "message": "Failed to parse request body. Make sure it is a valid JSON."
            }
        ]
    }
}

Response 429 Too many requests

This response indicates that the client sent more requests than allowed by this API for the current tier of the client.

json

{
    "error": {
        "code": "RateLimitExceeded",
        "message": "The client sent more requests than allowed by this API for the current tier of the client."
    }
}

Response headers

retry-after

Number of seconds to wait until client is allowed to make more requests.

Definitions

Release Locks Chunk

Properties for releasing a chunk of locks.

briefcaseId

Int32

Briefcase Id for which to release locks.

changesetId

String, null

Changeset Id. Meant to identify the latest Changeset in which the locked object was updated. If this value points to an older Changeset than the value saved in the server acquiring locks will fail.

json

{
    "type": "object",
    "title": "Release Locks Chunk",
    "description": "Properties for releasing a chunk of locks.",
    "properties": {
        "briefcaseId": {
            "type": "integer",
            "format": "int32",
            "description": "Briefcase Id for which to release locks."
        },
        "changesetId": {
            "type": "string",
            "description": "Changeset Id. Meant to identify the latest Changeset in which the locked object was updated. If this value points to an older Changeset than the value saved in the server acquiring locks will fail.",
            "nullable": true
        }
    },
    "required": [
        "briefcaseId"
    ],
    "additionalProperties": false
}

Release Locks Chunk Response

Response for releasing a chunk of locks.

isLastChunk

Boolean

Indicates whether this was the last chunk of locks to be released.

json

{
    "type": "object",
    "title": "Release Locks Chunk Response",
    "description": "Response for releasing a chunk of locks.",
    "properties": {
        "isLastChunk": {
            "type": "boolean",
            "description": "Indicates whether this was the last chunk of locks to be released."
        }
    },
    "additionalProperties": false
}

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.

json

{
    "type": "object",
    "description": "Contains error information.",
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        },
        "target": {
            "type": "string",
            "description": "The target of the error.",
            "nullable": true
        }
    },
    "required": [
        "code",
        "message"
    ],
    "additionalProperties": true
}

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.

json

{
    "type": "object",
    "title": "Error Response",
    "description": "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.",
    "properties": {
        "error": {
            "description": "Error information.",
            "$ref": "#/components/schemas/Error"
        }
    },
    "required": [
        "error"
    ],
    "additionalProperties": false
}

Was this page helpful?