Get iModel Briefcases - iModels

iModels

Download API definition:

GET https://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

Request parameters

Yes

iModel id

$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.

$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.

$orderBy

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

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

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Prefer

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

Response

Response 200 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 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

Briefcase (summary)

Summarized representation of the Briefcase.

String

Id of the Briefcase.

displayName

String

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

json

{
    "type": "object",
    "title": "Briefcase (summary)",
    "description": "Summarized representation of the Briefcase.",
    "properties": {
        "id": {
            "type": "string",
            "description": "Id of the Briefcase."
        },
        "displayName": {
            "type": "string",
            "description": "Display name of the Briefcase. Corresponds to id and deviceName properties."
        }
    },
    "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
}

Briefcases (prefer return=minimal)

List of Briefcases in minimal representation.

briefcases

BriefcaseSummary[]

Briefcases of the iModel.

_links

PagingLinks

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

json

{
    "type": "object",
    "title": "Briefcases (prefer return=minimal)",
    "description": "List of Briefcases in minimal representation.",
    "properties": {
        "briefcases": {
            "type": "array",
            "description": "Briefcases of the iModel.",
            "items": {
                "$ref": "#/components/schemas/BriefcaseSummary"
            }
        },
        "_links": {
            "$ref": "#/components/schemas/PagingLinks",
            "description": "Contains the hyperlinks to the previous and next pages of results."
        }
    },
    "additionalProperties": false
}

Briefcases (prefer return=representation)

List of Briefcases in full representation.

briefcases

Briefcase[]

Briefcases of the iModel.

_links

PagingLinks

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

json

{
    "type": "object",
    "title": "Briefcases (prefer return=representation)",
    "description": "List of Briefcases in full representation.",
    "properties": {
        "briefcases": {
            "type": "array",
            "description": "Briefcases of the iModel.",
            "items": {
                "$ref": "#/components/schemas/Briefcase"
            }
        },
        "_links": {
            "$ref": "#/components/schemas/PagingLinks",
            "description": "Contains the hyperlinks to the previous and next pages of results."
        }
    },
    "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
}

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.

json

{
    "type": "object",
    "title": "Paging Links",
    "description": "URLs for redoing the current request, getting to the previous or next page of results, if applicable.",
    "properties": {
        "self": {
            "description": "URL for redoing the current request.",
            "$ref": "#/components/schemas/Link"
        },
        "prev": {
            "description": "URL for getting the previous page of results.",
            "$ref": "#/components/schemas/Link"
        },
        "next": {
            "description": "URL for getting the next page of results.",
            "$ref": "#/components/schemas/Link"
        }
    },
    "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?