Acquire iModel Briefcase - iModels

iModels

Download API definition:

POST https://dev-api.bentley.com/imodels/{id}/briefcases

Acquires a new Briefcase.

Briefcases are the local copies of iModel that users can acquire to work with the iModel. Users can make changes to their copy of iModel and then push them as a single Changeset file into iModelHub. For more information on Briefcases see working with Briefcases.

Note: The total number of Briefcases a single user can acquire is limited. The error code ResourceQuotaExceeded is returned when you exceed the limit. The current limit is 100 total briefcases.

The number of Briefcases a single user can acquire per minute is also limited. The error code RateLimitExceeded is returned when you exceed the limit. The current limit per minute is 100.

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_read 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_read 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

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

Briefcase (acquire)

deviceName

String, null

Name of the device which will hold the briefcase.

Example

json

{
    "deviceName": "Device name"
}

Response

Response 201 Created

Created

json

{
    "briefcase": {
        "id": "2",
        "briefcaseId": 2,
        "displayName": "#2 Device Name",
        "ownerId": "42101fba-847a-4f4e-85a8-a4bed89065e4",
        "acquiredDateTime": "2020-10-20T10:51:33.1700000Z",
        "fileSize": 2048,
        "deviceName": "Device Name",
        "application": null,
        "_links": {
            "owner": {
                "href": "https://api.bentley.com/imodels/5e19bee0-3aea-4355-a9f0-c6df9989ee7d/users/42101fba-847a-4f4e-85a8-a4bed89065e4"
            },
            "checkpoint": {
                "href": "https://api.bentley.com/imodels/5e19bee0-3aea-4355-a9f0-c6df9989ee7d/briefcases/checkpoint"
            }
        }
    }
}

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 acquire a Briefcase.

json

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

Response 404 Not Found

Specified iModel 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 acquire Briefcase.",
        "details": [{
                "code": "InvalidValue",
                "message": "Provided 'deviceName' is not valid. The value exceeds allowed 255 characters.",
                "target": "deviceName"
            },
            {
                "code": "ResourceQuotaExceeded",
                "message": "Maximum number of Briefcases per user limit reached.",
                "innerError": {
                    "code": "MaximumNumberOfBriefcasesPerUser"
                }
            }
        ]
    }
}

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. It can also indicate that the client has tried to acquire too many briefcases within the last minute.

json

{
    "error": {
        "code": "RateLimitExceeded",
        "message": "Maximum number of briefcases per user per minute reached."
    }
}

Response headers

retry-after

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

Definitions

Briefcase Response

Container for Briefcase object.

briefcase

Briefcase

Briefcase properties.

json

{
    "type": "object",
    "title": "Briefcase Response",
    "description": "Container for Briefcase object.",
    "properties": {
        "briefcase": {
            "$ref": "#/components/schemas/Briefcase",
            "description": "Briefcase properties."
        }
    },
    "additionalProperties": false
}

Briefcase (acquire)

Properties of the Briefcase to be acquired.

deviceName

String, null

Name of the device which will hold the briefcase.

json

{
    "type": "object",
    "title": "Briefcase (acquire)",
    "description": "Properties of the Briefcase to be acquired.",
    "properties": {
        "deviceName": {
            "type": "string",
            "description": "Name of the device which will hold the briefcase.",
            "nullable": true
        }
    },
    "additionalProperties": false
}

Briefcase

Briefcase is a file holding a copy of an iModel.

String

Id of the Briefcase.

briefcaseId

Integer

Id of the Briefcase as an integer.

displayName

String

Display name of the Briefcase. Corresponds to id and deviceName properties.

acquiredDateTime

Date-time

Date when the Briefcase was acquired.

fileSize

Integer

DEPRECATED Size of the Briefcase in bytes.

deviceName

String, null

Name of the device which will hold the Briefcase.

ownerId

String

Id of the User owning Briefcase.

application

Application

Information about the application that acquired the Briefcase.

_links

BriefcaseLinks

Contains the hyperlinks to the related data of the Briefcase.

json

{
    "type": "object",
    "description": "Briefcase is a file holding a copy of an iModel.",
    "properties": {
        "id": {
            "type": "string",
            "description": "Id of the Briefcase."
        },
        "briefcaseId": {
            "type": "integer",
            "description": "Id of the Briefcase as an integer."
        },
        "displayName": {
            "type": "string",
            "description": "Display name of the Briefcase. Corresponds to id and deviceName properties."
        },
        "acquiredDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "Date when the Briefcase was acquired."
        },
        "fileSize": {
            "type": "integer",
            "description": "**DEPRECATED** Size of the Briefcase in bytes."
        },
        "deviceName": {
            "type": "string",
            "description": "Name of the device which will hold the Briefcase.",
            "nullable": true
        },
        "ownerId": {
            "type": "string",
            "description": "Id of the User owning Briefcase."
        },
        "application": {
            "$ref": "#/components/schemas/Application",
            "description": "Information about the application that acquired the Briefcase."
        },
        "_links": {
            "$ref": "#/components/schemas/BriefcaseLinks",
            "description": "Contains the hyperlinks to the related data of the Briefcase."
        }
    },
    "additionalProperties": false
}

Briefcase Links

Hyperlinks to Briefcase related data.

owner

Link

Information about the owner of the Briefcase.

checkpoint

Link

Link to get latest Checkpoint for an iModel.

json

{
    "type": "object",
    "title": "Briefcase Links",
    "description": "Hyperlinks to Briefcase related data.",
    "properties": {
        "owner": {
            "$ref": "#/components/schemas/Link",
            "description": "Information about the owner of the Briefcase."
        },
        "checkpoint": {
            "$ref": "#/components/schemas/Link",
            "description": "Link to get latest Checkpoint for an iModel."
        }
    },
    "additionalProperties": false
}

Link

Hyperlink container.

href

String

Hyperlink to the specific entity.

json

{
    "type": "object",
    "nullable": true,
    "description": "Hyperlink container.",
    "properties": {
        "href": {
            "type": "string",
            "description": "Hyperlink to the specific entity."
        }
    },
    "additionalProperties": false
}

Application

Information about the client application that is related to an entity.

String

Id of the application.

name

String

Application name.

json

{
    "type": "object",
    "nullable": true,
    "description": "Information about the client application that is related to an entity.",
    "properties": {
        "id": {
            "type": "string",
            "description": "Id of the application."
        },
        "name": {
            "type": "string",
            "description": "Application name."
        }
    },
    "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?