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 [iModel.js](https://www.itwinjs.org/) client libraries.


imodels

Data Management

---

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 be an Organization Administrator for the Organization that owns a given Project or have `imodels_manage` permission assigned at the Project level.

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

OAuth access token with scope `imodels:modify`

Authorization

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

Accept

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.

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.

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

---

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 Project level. If permissions at the iModel level are not configured, then user must have `imodels_webview` permission assigned at the Project level.

Alternatively the user should be an Organization Administrator for the Organization that owns a given Project 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/).

### 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 Project level. If permissions at the iModel level are not configured, then user must have `imodels_read` permission assigned at the Project level.

Alternatively the user should be an Organization Administrator for the Organization that owns a given Project 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`.

Content-Type

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 Project level. If permissions at the iModel level are not configured, then user must have `imodels_webview` permission assigned at the Project level.

Alternatively the user should be an Organization Administrator for the Organization that owns a given Project 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 Project level. If permissions at the iModel level are not configured, then user must have `imodels_webview` permission assigned at the Project level.

Alternatively the user should be an Organization Administrator for the Organization that owns a given Project 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. Currently the only supported value for this parameter is 'me' which references 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 Project 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 Project 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 iModel.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 Project level. If permissions at the iModel level are not configured, then user must have `imodels_write` permission assigned at the Project level.

Alternatively the user should be an Organization Administrator for the Organization that owns a given Project 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.

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 Project level. If permissions at the iModel level are not configured, then user must have `imodels_read` permission assigned at the Project level.

Alternatively the user should be an Organization Administrator for the Organization that owns a given Project 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 iModel.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 Project level. If permissions at the iModel level are not configured, then user must have `imodels_webview` permission assigned at the Project level.

Alternatively the user should be an Organization Administrator for the Organization that owns a given Project 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 iModel.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 Project level. If permissions at the iModel level are not configured, then user must have `imodels_webview` permission assigned at the Project level.

Alternatively the user should be an Organization Administrator for the Organization that owns a given Project 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 Project level. If permissions at the iModel level are not configured, then user must have `imodels_write` permission assigned at the Project level.

Alternatively the user should be an Organization Administrator for the Organization that owns a given Project 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 or another user is currently pushing a Changeset.

---

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 projects 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/operations/get-imodel-baseline-file/) 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 be an Organization Administrator for the Organization that owns a given Project or have `imodels_manage` permission assigned at the Project level.

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

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

---

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 be an Organization Administrator for the Organization that owns a given Project or have `imodels_delete` permission assigned at the Project level.

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 Project level. If permissions at the iModel level are not configured, then user must have `imodels_webview` permission assigned at the Project level.

Alternatively the user should be an Organization Administrator for the Organization that owns a given Project 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 Project.

### 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 Project level. If permissions at the iModel level are not configured, then user must have `imodels_webview` permission assigned at the Project level.

Alternatively the user should be an Organization Administrator for the Organization that owns a given Project 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-project-imodels

projectId

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

---

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 Project level. If permissions at the iModel level are not configured, then user must have `imodels_manage` permission assigned at the Project level.

Alternatively the user should be an Organization Administrator for the Organization that owns a given Project 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.

---

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 Project level. If permissions at the iModel level are not configured, then user must have `imodels_webview` permission assigned at the Project level.

Alternatively the user should be an Organization Administrator for the Organization that owns a given Project 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 Project 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 Project 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.

Lock are already owned by another briefcase and cannot be acquired or locks have been updated in a newer changeset.

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 Project level. If permissions at the iModel level are not configured, then user must have `imodels_write` permission assigned at the Project level.

Alternatively the user should be an Organization Administrator for the Organization that owns a given Project 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.

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 Project level. If permissions at the iModel level are not configured, then user must have `imodels_webview` permission assigned at the Project level.

Alternatively the user should be an Organization Administrator for the Organization that owns a given Project 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 Project level. If permissions at the iModel level are not configured, then user must have `imodels_webview` permission assigned at the Project level.

Alternatively the user should be an Organization Administrator for the Organization that owns a given Project 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 exact 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 Project level. If permissions at the iModel level are not configured, then user must have `imodels_read` permission assigned at the Project level.

Alternatively the user should be an Organization Administrator for the Organization that owns a given Project 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 Project level. If permissions at the iModel level are not configured, then user must have `imodels_write` permission assigned at the Project level.

Alternatively the user should be an Organization Administrator for the Organization that owns a given Project 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.

---

Retrieves a list of permissions the user has for the specified iModel. iModels permissions may be configured on a Project level or an iModel level. This operation will return permissions configured for this specific iModel or Project 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 Project level permission, but Create iModel operation requires that user has `imodels_manage` permission on the Project level. Use Projects API to check if user can create an iModel on a given Project.

`imodels-delete` - allows to delete an iModel. This permission is only available on the Project level. Use Projects API to check if user can delete iModels on a given Project.

### 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 Project level. If permissions at the iModel level are not configured, then user must have `imodels_webview` permission assigned at the Project level.

Alternatively the user should be an Organization Administrator for the Organization that owns a given Project 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

---

Retrieves a thumbnail file. Returned thumbnails 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 Project level. If permissions at the iModel level are not configured, then user must have `imodels_webview` permission assigned at the Project level.

Alternatively the user should be an Organization Administrator for the Organization that owns a given Project 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 or an invalid value is passed.

size

---

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 Project level. If permissions at the iModel level are not configured, then user must have `imodels_manage` permission assigned at the Project level.

Alternatively the user should be an Organization Administrator for the Organization that owns a given Project 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

Indicates that the file the user attempted to upload is above the maximum 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 Project level. If permissions at the iModel level are not configured, then user must have `imodels_webview` permission assigned at the Project level.

Alternatively the user should be an Organization Administrator for the Organization that owns a given Project 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 Project level. If permissions at the iModel level are not configured, then user must have `imodels_webview` permission assigned at the Project level.

Alternatively the user should be an Organization Administrator for the Organization that owns a given Project 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

Compare ChangedElements between Version and colorizing them by operation.

ecc2e721-1760-47b7-b3db-4647a84c2cfa

Uses the validation REST api to get and visualize clash results.

dc1910b2-a6dc-4848-81c1-df4e9d20ccdd

Uses issues REST API to retrieve issues associated with project and display them.

d7203008-19a4-4c45-8c64-3f16cc8b396a

Request and visualize the data in an insights report of iModel

6f6ed2b0-54b1-4645-8154-7c1b2c4eed21

How use the Transformations API to transform an iModel into another, and display them.

2f29a62e-2085-4c2b-a3e6-e85a444fbfaf

0c0e4c99-b759-4eda-b8c1-a96b9f66c1ef

This is a code sample application that demonstrates usage of the Synchronization API on the Bentley iTwin developer platform.

synchronization-api-sample-app

This is a code sample application that demonstrates usage of the Synchronization Manifest API on the Bentley iTwin developer platform.

synchronization-manifest-api-sample

This is a simple React based application that demonstrates iModel management workflow that can be achieved using iModels API.

imodels-api-management-workflow-sample-app

An iTwin sample application that demonstrates how to create, query and update files with folders saved in the Storage.

storage-api-sample-app

An iTwin sample application that demonstrates how to create, query and update an iTwin Project using the Project API. It also demonstrates how to create a project role and add a user to the project with that role.

project-api-sample-app

Node.js (Express) application that can capture webhook events, store the events in Azure Queue and provide an API endpoint for event polling.

webhooks-api-polling-sample-app

Node.js (Express) application that shows the basic examples of consuming Webhooks API and reacting to iTwin Platform events.

webhooks-api-sample-app

This sample demonstrates importing users into a project along with a list of project role assignments per user and copying project roles, users, and user project role assignments from one project to another.

platform-api-samples

This is a simple command line app that illustrates the workflow of configuring a report using the Reporting platform APIs.

insights-api-sample-console-app

The Design Element Classification sample is a simple command line app that illustrates the workflow of checking available model versions deployed and running a new run for an iModel.

designelementclassification-api-sample-console-app

An iTwin sample application that demonstrates how to create, upload and query components in a catalog.

library-api-sample-app

An iTwin.js  application that lets you view 2D models

88182d1b-b11f-457e-bcb1-7e5c449a341c

This is the simplest iTwin.js frontend example. It displays a viewport and shows a view navigation toolbar

483a9a98-d509-44ed-9699-a5bc8e7085a8

This sandbox demonstrates the display of global data sources and globe-based navigation terrain buildings global location maps

cc24218c-042a-4a96-b54a-f25beb570965

Adding, removing, and modifying the display of reality data. Discovers available realitymodel and attaches the first one to the viewport.

acf25c84-0665-459d-8b2b-f025566c379a

How to get and set various ViewFlags and other view attributes including: RenderMode, Skybox, BackgroundMap, Grid, ACS, and others.

83bafc4a-f9e4-406d-934b-b3c69bde1614

Animates the camera along a path using setEyePoint.  Also shows a tool to control the look direction using setupViewFromFrustum.

12510a7a-3103-4795-addc-4026cabeda2e

How to apply a classifier to a realitymodel. Also demonstrates how to adjust the display of classifier, in this case a spatial classifier

026f60e8-1e30-466e-8c90-c2feb6f0ace4

This sample demonstrates how to implement basic cross-probing between 2D and 3D elements given an iModel of a Plant

18f5a227-1aa2-4f2f-b692-4d269cc56400

Customize the appearance of a 3d viewport using Display Styles

593d8ba7-550c-4176-af17-7d0def871da8

How to emphasize, hide, isolate, and override the color of elements using the EmphasizeElements API.

5180d906-3629-476b-90bc-d7e0d04e0dc9

Uses a TileTree to create an explode effect in the viewport.

68f4318f-5ecf-4290-b225-9114304e77cf

Creates an fire effect using particles Decorator.

7a9669c3-bda7-456b-9a92-454f561c15b2

Uses a Decorator to show a heatmap as a WorldOverlay on top of the viewport.

eca24a40-0aef-4ae1-aa10-48942204350a

Navigate between 2d and 3d views using hyper-modeling

cd20e590-d269-4f41-88e2-61551e3000ed

Exports visible viewport of iModel as PNG image. ImageExport

a2d84a9e-bdc2-4aea-848f-7f244f360278

How to simulate out-of-bound condition from a sensor and trigger IotAlert, blinking effect

0d1a3def-21a0-4f6f-b460-79193fc072c7

Uses a Decorator and a MarkerSet to display markers that indicate important locations in a model.

iModels

Samples