Table of contents
iModels
Download API definition:
GET https://qa-api.bentley.com/imodels/{id}/briefcases[?$top][&$skip][&$orderBy][&ownerId]

Retrieves a list of Briefcases for the iModel specified by the iModel id.

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.

Notes

The Prefer header can be used to specify how much result metadata is desired by the client. The Prefer request header field is used to indicate that particular server behaviors are preferred by the client but are not required for successful completion of the request.

This operation supports "return=representation" and "return=minimal" preferences.

The "return=representation" preference indicates that the client prefers that the server include an entity representing the current state of the resource in the response to a successful request. The "return=minimal" preference indicates that the client wishes the server to return only a minimal response to a successful request. This is the default preference if Prefer header is not specified.

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 parameters

Name
Required?
Description
id
Yes

iModel id

$top
No

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.

$skip
No

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.

$orderBy
No

The $orderBy query option allows clients to request ascending using 'asc' or descending using 'desc' order of the returned collection by one or more item properties. Currently the only supported property for Briefcases is 'acquiredDateTime'. When neither 'asc' or 'desc' keyword is specified the collection is sorted in ascending order. To sort the collection in descending order provide 'desc' keyword e.g.: $orderBy=acquiredDateTime desc

ownerId
No

The ownerId query option allows users to filter Briefcases by their ownerId property. Valid values for this parameter are strings. Strings should be not empty, consist not only of whitespace and not exceed 255 characters. The 'me' keyword can be used to reference the current user. Current user is a user that the access token used for request belongs to. E.g. to return Briefcases owned by the current user provide the following query: ownerId=me.

Request headers

Name
Required?
Description
Authorization
Yes

OAuth access token with itwin-platform scope

Accept
Yes

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

Prefer
No

Indicates a level of details in the response. This operation supports 'return=representation' and 'return=minimal' preferences.

Response 200 OK

OK

json
{
    "briefcases": [{
            "id": "2",
            "displayName": "#2 Device Name"
        },
        {
            "id": "3",
            "displayName": "#3 Device Name"
        }
    ],
    "_links": {
        "self": {
            "href": "https://api.bentley.com/imodels/5e19bee0-3aea-4355-a9f0-c6df9989ee7d/briefcases?$skip=0&$top=100"
        },
        "prev": {
            "href": "https://api.bentley.com/imodels/5e19bee0-3aea-4355-a9f0-c6df9989ee7d/briefcases?$skip=0&$top=100"
        },
        "next": {
            "href": "https://api.bentley.com/imodels/5e19bee0-3aea-4355-a9f0-c6df9989ee7d/briefcases?$skip=0&$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 Briefcases.",
        "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

Name
Description
retry-after

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

Briefcase (summary)

Summarized representation of the Briefcase.

Name
Type
Description
id
String

Id of the Briefcase.

displayName
String

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

Briefcase

Briefcase is a file holding a copy of an iModel.

Name
Type
Description
id
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

Information about the application that acquired the Briefcase.

_links

Contains the hyperlinks to the related data of the Briefcase.

Briefcases (prefer return=minimal)

List of Briefcases in minimal representation.

Name
Type
Description
briefcases

Briefcases of the iModel.

_links

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

Briefcases (prefer return=representation)

List of Briefcases in full representation.

Name
Type
Description
briefcases

Briefcases of the iModel.

_links

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

Briefcase Links

Hyperlinks to Briefcase related data.

Name
Type
Description
owner

Information about the owner of the Briefcase.

checkpoint

Link to get latest Checkpoint for an iModel.

Link

Hyperlink container.

Name
Type
Description
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.

Name
Type
Description
self

URL for redoing the current request.

prev

URL for getting the previous page of results.

next

URL for getting the next page of results.

Application

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

Name
Type
Description
id
String

Id of the application.

name
String

Application name.

Error

Contains error information.

Name
Type
Description
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.

Name
Type
Description
error

Error information.

Was this page helpful?