iModelHub is the control center for iModels. It is responsible for coordinating concurrent access to iModels as well as changes made to them in a form of [Changesets](https://www.itwinjs.org/learning/glossary/#changeset).

Overview of [iModelHub](https://www.itwinjs.org/learning/imodelhub/) and [iModels](https://www.itwinjs.org/learning/imodels/).

These APIs lets you retrieve metadata about the iModels pushed to iModelHub. To view, create or update your iModels use [iTwin.js](https://www.itwinjs.org/) client libraries.


imodels-v2

imodels

---

Uploads a Thumbnail file. Request content should be binary content of an image. Supported Thumbnail types are 'image/png' or 'image/jpeg', but once uploaded 'image/jpeg' will be converted to 'image/png'. Maximum supported Thumbnail size is 5 megabytes.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `imodels:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have `imodels_manage` permission assigned at the iModel level and at least `imodels_webview` permission assigned at the iTwin level. If permissions at the iModel level are not configured, then user must have `imodels_manage` 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.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---


upload-imodel-thumbnail

OAuth access token with scope `imodels:modify`

Authorization

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

Accept

Content-Type

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.

application/json;InvalidAuthorizationScheme

User is not authorized to upload a Thumbnail.

iModel is not initialized and modify operations are not allowed.

Indicates that the file the user attempted to upload is above the maximum size.

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)

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

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

retry-after

image

Error

One of a server-defined set of error codes.

code

string

A human-readable representation of the error.

message

target

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.

ErrorResponse

error

Error Response

---

Complete [iModel](https://www.itwinjs.org/learning/glossary/#imodel) creation from Baseline File by confirming that file was uploaded to file storage.

 Baseline File is the base iModel file that does not have any changesets applied. For creating an iModel from a custom Baseline File see [Create iModel using a Baseline File](https://developer.bentley.com/apis/imodels/operations/create-imodel/#createanimodelusingabaselinefile).

### Authentication

Requires `Authorization` header with valid Bearer token for scope `imodels:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have the `imodels_manage` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---


complete-imodel-baseline-file-upload

User is not authorized to complete Baseline File upload.

Specified iModel was not found, it does not have an associated Baseline File entity or the file was not uploaded to the storage.

File size specified during iModel creation does not match the actual file size of the uploaded file.

---

Retrieves the metadata of a Baseline File. Baseline File is the base iModel file that does not have any changesets applied.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `imodels:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have `imodels_webview` permission assigned at the iModel level and 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.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

**Note:** `download` property requires user to have at least `imodels_read` permission. If user has only `imodels_webview` permission `download` will always be null.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---


get-imodel-baseline-file-details

OAuth access token with scope `imodels:read`

Specified iModel was not found or it does not have an associated Baseline File entity.

---

Acquires a new [Briefcase](https://www.itwinjs.org/learning/glossary/#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](https://www.itwinjs.org/learning/imodelhub/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 `imodels:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have `imodels_read` permission assigned at the iModel level and 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.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---


acquire-imodel-briefcase

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

User is not authorized to acquire a Briefcase.

Indicates how long the user agent should wait before making a follow-up request.

---

Retrieves the details of a [Briefcase](https://www.itwinjs.org/learning/glossary/#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](https://www.itwinjs.org/learning/imodelhub/briefcases/).

### Authentication

Requires `Authorization` header with valid Bearer token for scope `imodels:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have `imodels_webview` permission assigned at the iModel level and 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.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---


get-imodel-briefcase-details

briefcaseId

Specified iModel or Briefcase was not found.

---

Retrieves a list of [Briefcases](https://www.itwinjs.org/learning/glossary/#briefcase) 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](https://www.itwinjs.org/learning/imodelhub/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 `imodels:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have `imodels_webview` permission assigned at the iModel level and 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.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---


get-imodel-briefcases

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.

$top

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.

$skip

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.

ownerId

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

Prefer

---

Deletes the specified [Briefcase](https://www.itwinjs.org/learning/glossary/#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](https://www.itwinjs.org/learning/imodelhub/briefcases/).

### Authentication

Requires `Authorization` header with valid Bearer token for scope `imodels:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

To release any Briefcase 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 a Briefcase that the user owns `imodels_webview` permission is enough.

Alternatively the user should be an Organization Administrator for the Organization that owns a given iTwin the iModel belongs to.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

release-imodel-briefcase

User is not authorized to release a Briefcase.

---

Creates the metadata of a [Changeset](https://www.itwinjs.org/learning/glossary/#changeset).

For more information on creating and retrieving Changesets using iTwin.js see [working with Changesets](https://www.itwinjs.org/learning/imodelhub/briefcases/).

 **Important: This operation should only be used by iTwin.js. For creating and uploading a valid Changeset please use iTwin.js libraries.**

Pushing a Changeset consists of three steps:

1. Create Changeset metadata.
2. Upload Changeset file to blob storage using `upload` property link from the response of Changeset metadata creation.
```
Request syntax:
    PUT upload HTTP/1.1
Request headers:
    x-ms-blob-type: BlockBlob
```

3. Complete the Changeset push by confirming that Changeset file was uploaded successfully. See [Update iModel Changeset](https://developer.bentley.com/apis/imodels/operations/update-imodel-changeset/) operation for the documentation.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `imodels:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have `imodels_write` permission assigned at the iModel level and at least `imodels_webview` permission assigned at the iTwin level. If permissions at the iModel level are not configured, then user must have `imodels_write` 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.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

create-imodel-changeset

User is not authorized to create a Changeset.

iModel is not initialzied, a Changeset with the same id already exists, 'parentId' property value does not point to the latest changes or another user is currently in a process of pushing a changeset.

---

Checkpoint is a pre-processed iModel baseline file that has changes up to a certain Changeset already applied and is stored on the server. This can be used to reduce number of Changesets needed to apply to get to a certain version of the iModel.

A Checkpoint is generated when a Named Version is created for that changeset.

Checkpoint can be stored in two different ways:

1. `download` property will have a Azure Blob storage link to a full `.bim` file that has changes applied up to the Changeset specified by `changesetIndex` and `changesetId` properties.
2. `containerAccessInfo` will have an access key to Azure Blob container that stores the Checkpoint in 4 MB blocks. **Important: This property should only be used by iTwin.js libraries.**

A successfully generated Checkpoint will have one or both of these properties.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `imodels:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have `imodels_read` permission assigned at the iModel level and 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.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---


get-changeset-checkpoint

changeset

Specified iModel, Changeset or Checkpoint was not found.

---

Retrieves the metadata of a [Changeset](https://www.itwinjs.org/learning/glossary/#changeset).

For more information on creating and retrieving Changesets using iTwin.js see [working with Changesets](https://www.itwinjs.org/learning/imodelhub/briefcases/).

### Authentication

Requires `Authorization` header with valid Bearer token for scope `imodels:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have `imodels_webview` permission assigned at the iModel level and 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.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

**Note:** `download` property requires user to have at least `imodels_read` permission. If user has only `imodels_webview` permission `download` will always be null.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---


get-imodel-changeset-details

Specified iModel or Changeset was not found.

---

Retrieves a list of [Changesets](https://www.itwinjs.org/learning/glossary/#changeset) for the iModel specified by the iModel id.

[Changesets](https://www.itwinjs.org/learning/glossary/#changeset) form a linear timeline of the iModel changes. 
For more information on creating and retrieving Changesets using iTwin.js see [working with Changesets](https://www.itwinjs.org/learning/imodelhub/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 `imodels:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have `imodels_webview` permission assigned at the iModel level and 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.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

**Note:** `download` property requires user to have at least `imodels_read` permission. If user has only `imodels_webview` permission `download` will always be null.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---


get-imodel-changesets

The $orderBy query option allows clients to request ascending using 'asc' or descending using 'desc' order of the returned collection by one of the item properties. Currently the only supported property for Changesets is 'index'. 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=index desc

$orderBy

The afterIndex query option allows clients to query Changesets which have an index that is greater than the one specified in the query. E.g. to return Changesets that have an index greater than or equal to 2 provide the following query: afterIndex=1. This query option is useful when user wants to query the most recent Changesets starting from the one that is already present in the local copy of the iModel. This can be used together with lastIndex option to specify Changeset index range, afterIndex denotes an exclusive start of the range.

afterIndex

The lastIndex query option allows clients to query Changesets which have an index that is less than or equal to the one specified in the query. E.g. to return Changesets that have an index less than or equal to 10 provide the following query: lastIndex=10. This can be used together with afterIndex option to specify Changeset index range, lastIndex denotes an inclusive end of the range.

lastIndex

---

Confirm that [Changeset](https://www.itwinjs.org/learning/glossary/#changeset) file has been uploaded to file storage and finalize Changeset push.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `imodels:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have `imodels_write` permission assigned at the iModel level and at least `imodels_webview` permission assigned at the iTwin level. If permissions at the iModel level are not configured, then user must have `imodels_write` 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.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---


update-imodel-changeset

changesetId

User is not authorized to update a Changeset.

Specified iModel, Changeset, Briefcase or file was not found. FileNotFound will be returned if the server cannot find the uploaded Changeset file.

Changeset already exists, another user is currently pushing a Changeset or the iModel is not initialized.

---

Clones the specified iModel. 

Cloning an iModel means that a new iModel is created by importing data from the source iModel. That new iModel is considered to be an iModel clone. Id of the source iModel is specified in the request url while the id of the target iTwin which will contain the new iModel is specified in the request body.

### Relationship between the source iModel and the iModel clone

iModel clone is a valid standalone iModel. After the iModel cloning process is completed, no new changes are synchronized to the iModel clone from the source iModel. iModel clone is not deleted if the source iModel is deleted.

### Content and metadata of the iModel clone

The target iModel name and description can be specified when cloning an iModel, by default name and description are taken from the source iModel. iModel extent is always taken from the source iModel.

[iModel Baseline](https://developer.bentley.com/apis/imodels-v2/operations/get-imodel-baseline-file-details/) is always copied from the source iModel to the target iModel. User can specify until which point [Changesets](https://developer.bentley.com/apis/imodels-v2/operations/get-imodel-changesets/) should be copied to the target iModel, by default all source iModel Changesets are copied. The rest of source iModel entities are not copied.

### Operation state

Clone iModel is an asynchronous operation. To check the status of the operation please follow the link present in `Create-iModel-Operation` response header. The link points to [Get Create iModel Operation details](https://developer.bentley.com/apis/imodels-v2/operations/get-create-imodel-operation-details/) endpoint of the target iModel. When the target iModel's Create Operation `state` property is set to `successful` it means the cloning process is complete and iModel is ready to be used.

`Location` header value is a link to [Get iModel details](https://developer.bentley.com/apis/imodels-v2/operations/get-imodel-details/) endpoint of the target iModel which provides metadata about the the target iModel as well as when it is ready to be used. When target iModel's `state` property is set to `initialized` the iModel is ready to be used.

Please note that iModel may be marked as `initialized` before the iModel Create Operation is marked as `successful`. Such behavior allows target iModel to be utilized faster. The cloning background process first of all copies the critical iModel data and marks the iModel as `initialized`, and then copies additional data used to improve performance for iModel viewing and authoring workflows.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `imodels:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have the following permissions:
- `imodels_manage` permission at the source iModel iTwin level. 
- `imodels_manage` permission at the target iTwin level. 

If source iModel has iModel level permissions configured, then user must have at least `imodels_webview` permission assigned at iModel level.

Alternatively the user should be an Organization Administrator both for the Organization that owns source iModel iTwin and the Organization that owns target iTwin.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

This operation has a lower rate limit than the rest of iModels API operations. If an application exceeds the rate limit it will receive an HTTP error code 429 "Too Many Requests". The error response includes a Retry-After header that indicates how long clients should wait before retrying.

| Tier                           | Rate limit          |
| ------------------------------ | ------------------- |
| Trial                          | 5 calls per minute  |
| Developer, Partner, Integrator | 20 calls per minute |
<br/>
---


clone-imodel

Target iModel name

The resource location which is a URL to the new iModel.

Location

A URL which points to [Get Create iModel Operation details](https://developer.bentley.com/apis/imodels-v2/operations/get-create-imodel-operation-details/) endpoint for the new iModel.

Create-iModel-Operation

Specified source iTwin, iModel or Changeset were not found.

iModel with the same name already exists in the iTwin or the source iModel is not initialized.

---

Creates an [iModel](https://www.itwinjs.org/learning/glossary/#imodel).
There are three different ways to create an iModel.

### Create an empty iModel
 To create an empty iModel do not provide `template` and `baselineFile` properties.

### Create an iModel from an existing iModel
 To create an iModel from another iModel provide `template` property. The server will apply changesets up to the one specified by `changesetId` property to the source iModel file and use it as a Baseline File for the newly created iModel. User must have `imodels_read` permissions to the source iModel. Source and target iTwins must be in the same data center.

### Create an iModel using a Baseline File.
Creating an iModel using a Baseline File allows to upload a custom iModel file that will become the base file of the created iModel. There are three steps in creating an iModel from a Baseline File:

1. Create a new iModel and provide `baselineFile` property. **It is important to provide correct file size or the iModel creation will fail in the later steps.**

2. Upload Baseline File to blob storage using `upload` property link from the response of iModel creation.
```
Request syntax:
    PUT upload HTTP/1.1
Request headers:
    x-ms-blob-type: BlockBlob
```

3. Complete the iModel creation by confirming that Baseline File was uploaded successfully. See [Complete iModel Baseline Upload](https://developer.bentley.com/apis/imodels/operations/complete-imodel-baseline-file-upload/) operation for the documentation.

### iModel initialization

When creating an empty iModel it will be initialized immediately. When creating an iModel using `template` or `baselineFile` properties initialization will be scheduled and it's state is reflected in the `state` property. For a more detailed information about initialization state see [Get iModel Baseline File](https://developer.bentley.com/apis/imodels/operations/get-imodel-baseline-file-details/) operation.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `imodels:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have the `imodels_manage` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

This operation has a lower rate limit than the rest of iModels API operations. If an application exceeds the rate limit it will receive an HTTP error code 429 "Too Many Requests". The error response includes a Retry-After header that indicates how long clients should wait before retrying.

| Tier                           | Rate limit          |
| ------------------------------ | ------------------- |
| Trial                          | 5 calls per minute  |
| Developer, Partner, Integrator | 50 calls per minute |
<br/>
---

create-imodel

Overall model of wind and solar farms in Sun City

Sun City Renewable-energy Plant

application/json;iModel from Baseline File

User is not authorized to create an iModel.

iModel with the same name already exists within the iTwin.

---

Deletes [iModel](https://www.itwinjs.org/learning/glossary/#imodel).

### Authentication

Requires `Authorization` header with valid Bearer token for scope `imodels:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have the `imodels_delete` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---


delete-imodel

User is not authorized to delete an iModel.

---

Retrieves the metadata of an [iModel](https://www.itwinjs.org/learning/glossary/#imodel).

### Authentication

Requires `Authorization` header with valid Bearer token for scope `imodels:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have `imodels_webview` permission assigned at the iModel level and 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.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---


get-imodel-details

---

Retrieves a list of iModels belonging to the specified iTwin.

### 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 `imodels:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have `imodels_webview` permission assigned at the iModel level and 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.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---


get-itwin-imodels

iTwinId

The $orderBy query option allows clients to request ascending using 'asc' or descending using 'desc' order of the returned collection by one of the item properties. Currently the only supported property for iModels is 'name'. 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=name desc

The name query option allows users to filter iModels by their name property. E.g. to return iModels that have a name equal to 'Sun City Renewable-energy Plant' provide the following query: name=Sun%20City%20Renewable-energy%20Plant. Valid values for this parameter follow the same requirements as for iModel creation - strings should be not empty, consist not only of whitespace and not exceed 255 characters. This query option uses exact matching.

name

The state query option allows users to filter iModels by their state property. To return iModels that are initialized, provide initialized keyword e.g.: state=initialized. Valid values for this parameter are 'state=initialized' or 'state=notInitialized'.

state

---

Update metadata of the [iModel](https://www.itwinjs.org/learning/glossary/#imodel).

### Authentication

Requires `Authorization` header with valid Bearer token for scope `imodels:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have `imodels_manage` permission assigned at the iModel level and at least `imodels_webview` permission assigned at the iTwin level. If permissions at the iModel level are not configured, then user must have `imodels_manage` 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.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---


update-imodel

User is not authorized to update an iModel.

iModel with the same name already exists within the iTwin or the iModel is not initialized.

---

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](https://www.itwinjs.org/learning/backend/concurrencycontrol/#pessimistic-concurrency-control).

**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 `imodels:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have `imodels_webview` permission assigned at the iModel level and 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.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---


get-imodel-locks

Allows filtering locks by Briefcase Id and query only locks of a single briefcase.

---

Acquires requested locks on specified objects.
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](https://www.itwinjs.org/learning/backend/concurrencycontrol/#pessimistic-concurrency-control).

**Note:** Lock types have been removed for this API and should be ignored.

**Object ids Limit:** Currently there can be at most 1000 object ids in a single request.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `imodels:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

To release any Locks (set `LockLevel` to `none`) 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 acquire or realese 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.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---


update-imodel-locks

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

Locks are already owned by another briefcase and cannot be acquired, locks have been updated in a newer changeset or the iModel is not initialized.

Indicates that the request payload contains too many object ids.

---

Create a [Named Version](https://www.itwinjs.org/learning/glossary/#namedversion).

Every [Changeset](https://www.itwinjs.org/learning/glossary/#changeset) on the timeline creates a new version of the iModel. However, some points on the timeline can represent important milestones or significant events to be saved. iModelHub provides a way to mark a point on the timeline with a name. These time points are referred to as Named Versions.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `imodels:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have `imodels_write` permission assigned at the iModel level and at least `imodels_webview` permission assigned at the iTwin level. If permissions at the iModel level are not configured, then user must have `imodels_write` 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.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---


create-imodel-named-version

Wind farm design

User is not authorized to create a Named Version.

Named Version with the same name or Changeset already exists or iModel is not initialized.

application/json;NamedVersionOnChangesetExists

---

Retrieves the details of a Named Version.

Every [Changeset](https://www.itwinjs.org/learning/glossary/#changeset) on the timeline creates a new version of the iModel. However, some points on the timeline can represent important milestones or significant events to be saved. iModelHub provides a way to mark a point on the timeline with a name. These time points are referred to as Named Versions.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `imodels:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have `imodels_webview` permission assigned at the iModel level and 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.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---


get-imodel-named-version-details

namedVersionId

Requested iModel or Named Version was not found.

---

Retrieves a list of Named Versions for the iModel specified by the iModel id.

Every [Changeset](https://www.itwinjs.org/learning/glossary/#changeset) on the timeline creates a new version of the iModel. However, some points on the timeline can represent important milestones or significant events to be saved. iModelHub provides a way to mark a point on the timeline with a name. These time points are referred to as Named Versions.

### 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 `imodels:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have `imodels_webview` permission assigned at the iModel level and 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.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---


get-imodel-named-versions

The $orderBy query option allows clients to request ascending using 'asc' or descending using 'desc' order of the returned collection by one of the item properties. Currently the only supported property for Named Versions is 'changesetIndex'. 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=changesetIndex desc

The name query option allows users to filter Named Versions by their name property. E.g. to return Named Versions that have a name equal to 'Milestone 1' provide the following query: name=Milestone%201. Valid values for this parameter follow the same requirements as for Named Version creation - strings should be not empty, consist not only of whitespace and not exceed 255 characters. This query option uses case insensitive matching.

---

Checkpoint is a pre-processed iModel baseline file that has changes up to a certain Changeset already applied and is stored on the server. This can be used to reduce number of Changesets needed to apply to get to a certain version of the iModel.

A Checkpoint is generated when a Named Version is created for that changeset.

Checkpoint can be stored in two different ways:
1. `download` property will have a Azure Blob storage link to a full `.bim` file that has changes applied up to the Changeset specified by `changesetIndex` and `changesetId` properties.
2. `containerAccessInfo` will have an access key to Azure Blob container that stores the Checkpoint in 4 MB blocks. **Important: This property should only be used by iTwin.js libraries.**

A successfully generated Checkpoint will have one or both of these properties.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `imodels:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have `imodels_read` permission assigned at the iModel level and 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.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---


get-named-version-checkpoint

Specified iModel, Named Version or Checkpoint was not found.

---

Update metadata of a [Named Version](https://www.itwinjs.org/learning/glossary/#namedversion).

Every [Changeset](https://www.itwinjs.org/learning/glossary/#changeset) on the timeline creates a new version of the iModel. However, some points on the timeline can represent important milestones or significant events to be saved. iModelHub provides a way to mark a point on the timeline with a name. These time points are referred to as Named Versions.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `imodels:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have `imodels_write` permission assigned at the iModel level and at least `imodels_webview` permission assigned at the iTwin level. If permissions at the iModel level are not configured, then user must have `imodels_write` 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.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---


update-imodel-named-version

User is not authorized to update a Named Version.

Specified iModel or Named Version was not found.

Named Version with the same name already exists within the iModel or the iModel is not initialized.

---

Returns the information about iModel creation process.

### Cloned iModels

When an iModel is a clone, the `clonedFrom` response entity property will contain information about the source iModel from which this iModel was created, otherwise it will be `null`. For more information on iModel cloning are please refer to the [Clone iModel](https://developer.bentley.com/apis/imodels-v2/operations/clone-imodel/) documentation.

This endpoint can be used to check if iModel cloning completed. Alternatively users could periodically query [iModel details](https://developer.bentley.com/apis/imodels-v2/operations/get-imodel-details/) until the `state` property is set to `initialized`.

To get more information about the source iModel query [iModel Details](https://developer.bentley.com/apis/imodels-v2/operations/get-imodel-details/) with id specified in `clonedFrom.iModelId` property.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `imodels:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have `imodels_webview` permission assigned at the iModel level and 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.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---


get-create-imodel-operation-details

---

Retrieves a list of permissions the user has for the specified iModel. iModels permissions may be configured on an iTwin level or an iModel level. This operation will return permissions configured for this specific iModel or iTwin permissions if iModel permissions are not configured.

`imodels_webview` - allows to view iModel in web browser, but does not allow to get its local copy and view in desktop app.

`imodels_read` - allows to open and view an iModel only in read-only state.

`imodels_write` - allows to make changes to an iModel. Allows to create and modify named versions. Allows to create mapping between PW connection and iModel to facilitate bridges.

`imodels_manage` - allows to create an iModel. Allows to configure access per iModel. Allows to manage locks, codes or local copies for the entire iModel. This permission is both iModel and iTwin level permission, but Create iModel operation requires that user has `imodels_manage` permission on the iTwin level.

`imodels_delete` - allows to delete an iModel. This permission is only available on the iTwin level.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `imodels:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have `imodels_webview` permission assigned at the iModel level and 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.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

get-imodel-user-permissions

---

Creates a new Share to allow public iModel access.

iModels Share API provides a way to publicly share an iModel. Each Share instance has a `shareKey` property which allows anonymous access to the shared iModel using iModels API.
To use the `shareKey` to access the iModel one has to provide `shareKey` via `Authorization` header: `Authorization: Basic {shareKey}`, when calling iModels API.

All Share operations interact only with the Share instances that the calling user has created. E.g. querying iModel Shares will not return all the Shares iModel has, but only the Shares which were created by the user who is calling the API.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `imodels:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have the `imodels_manage` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

**Important**: Share operations are in closed preview mode currently. Hence only selected applications can utilize the Share API.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

create-imodel-share

iModel Share name

User is not authorized to create an iModel Share.

---

Retrieves the details of a Share.

iModels Share API provides a way to publicly share an iModel. Each Share instance has a `shareKey` property which allows anonymous access to the shared iModel using iModels API.
To use the `shareKey` to access the iModel one has to provide `shareKey` via `Authorization` header: `Authorization: Basic {shareKey}`, when calling iModels API.

All Share operations interact only with the Share instances that the calling user has created. E.g. querying iModel Shares will not return all the Shares iModel has, but only the Shares which were created by the user who is calling the API.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `imodels:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have `imodels_webview` permission assigned at the iModel level and 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.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

**Important**: Share operations are in closed preview mode currently. Hence only selected applications can utilize the Share API.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

get-imodel-share

shareId

---

Retrieves a list of Shares of the given iModel created by the calling user.

iModels Share API provides a way to publicly share an iModel. Each Share instance has a `shareKey` property which allows anonymous access to the shared iModel using iModels API.
To use the `shareKey` to access the iModel one has to provide `shareKey` via `Authorization` header: `Authorization: Basic {shareKey}`, when calling iModels API.

All Share operations interact only with the Share instances that the calling user has created. E.g. querying iModel Shares will not return all the Shares iModel has, but only the Shares which were created by the user who is calling the API.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `imodels:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have `imodels_webview` permission assigned at the iModel level and 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.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

**Important**: Share operations are in closed preview mode currently. Hence only selected applications can utilize the Share API.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

get-imodel-shares

---

Deletes a Share making the `shareKey` invalid.

iModels Share API provides a way to publicly share an iModel. Each Share instance has a `shareKey` property which allows anonymous access to the shared iModel using iModels API.
To use the `shareKey` to access the iModel one has to provide `shareKey` via `Authorization` header: `Authorization: Basic {shareKey}`, when calling iModels API.

All Share operations interact only with the Share instances that the calling user has created. E.g. querying iModel Shares will not return all the Shares iModel has, but only the Shares which were created by the user who is calling the API.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `imodels:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have `imodels_webview` permission assigned at the iModel level and 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.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

**Important**: Share operations are in closed preview mode currently. Hence only selected applications can utilize the Share API.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

revoke-imodel-share

User is not authorized to revoke a Share.

---

Extend the expiration date of a Share.

iModels Share API provides a way to publicly share an iModel. Each Share instance has a `shareKey` property which allows anonymous access to the shared iModel using iModels API.
To use the `shareKey` to access the iModel one has to provide `shareKey` via `Authorization` header: `Authorization: Basic {shareKey}`, when calling iModels API.

All Share operations interact only with the Share instances that the calling user has created. E.g. querying iModel Shares will not return all the Shares iModel has, but only the Shares which were created by the user who is calling the API.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `imodels:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have `imodels_webview` permission assigned at the iModel level and 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.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

**Important**: Share operations are in closed preview mode currently. Hence only selected applications can utilize the Share API.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

update-imodel-share

User is not authorized to update a Share.

---

Retrieves a Thumbnail file. Returned Thumbnail will be 'image/png' type.


One may specify either the *small* or *large* Thumbnail via the *size* query parameter.  If *size* is not specified, the small Thumbnail will be returned.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `imodels:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have `imodels_webview` permission assigned at the iModel level and 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.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---


get-imodel-thumbnail

Indicate Thumbnail size. Defaults to *small* if this parameter is not provided.

size

---

Retrieves the details about the user.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `imodels:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have `imodels_webview` permission assigned at the iModel level and 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.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---


get-imodel-user-details

userId

---

Retrieves a list of users who have ever been connected to the iModel specified by the iModel id.

### 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 `imodels:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have `imodels_webview` permission assigned at the iModel level and 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.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---


get-imodel-users

Upload iModel Thumbnail - iModels | iTwin Platform

Walk-through how to create an empty iModel which later can be used for synchronization.

Create an empty iModel

Walk-through how to create a new Named Version within existing iModel.

Create iModel Named Version

Walk-through how to synchronize a file from iTwin Storage to an iModel using Synchronization API.

Synchronize a file from iTwin Storage

Walk-through how to synchronize a file from Azure Blob Storage to an iModel using Synchronization API.

Synchronize a file from Azure Blob Storage

Walk-through how to unmap an Azure Blob Storage file from an iModel using Synchronization API.

Unmap an Azure Blob Storage file from an iModel

This tutorial guides you through exporting data from an iModel to other formats, such as IFC or LandXM using the Export API.

Thumbnails

Authentication

Authorization

Rate limits

Request

Request parameters

Request headers

Request body

Example

Response

Response 201 Created

Response 401 Unauthorized

Response 403 Forbidden

Response 404 Not Found

Response 409 Conflict

Response 413 Request Entity Too Large

Response 422 Unprocessable Entity

Response 429 Too many requests

Definitions

image

Error

Error Response