Table of contents
iModels
Download API definition:

Changelog

Mar 18, 2025

Announcement

$skip query parameter in Get iModel Briefcases, Get iModel Changesets, Get iModel Locks, Get iModel Named Versions, Get iModel Users and Get iTwin iModels operations is deprecated. Avoid using it as future API versions will not have this parameter. Use $continuationToken parameter instead.

Added

Added optional $continuationToken query parameter to Get iModel Briefcases, Get iModel Changesets, Get iModel Locks, Get iModel Named Versions, Get iModel Users and Get iTwin iModels operations.

Feb 27, 2025

Announcement

containerAccessInfo property in Get Changeset Checkpoint, Get Briefcase Checkpoint and Get Named Version Checkpoint operations is deprecated. Avoid using it as future API versions will not have this property. Use directoryAccessInfo property instead.

Create iModel operation now accepts optional creationMode property. It will be required in future API versions. Empty instantly initialized iModel creation is deprecated.

Added

Added directoryAccessInfo and dbName properties to Get Changeset Checkpoint, Get Briefcase Checkpoint and Get Named Version Checkpoint operations response.

Added storageType property to all upload and download links.

Added optional creationMode and geographicCoordinateSystem properties to Create iModel operation request.

Sep 23, 2024

Announcement

LastAccessTime property in Get iModel Users and Get iModel User operations is deprecated. Avoid using it as future API versions will not have this property.

May 15, 2024

Added

Added technology preview operation Get Briefcase Checkpoint.

Added technology preview operation Get iModel User Permissions.

Added technology preview operation Update iModel User Permissions.

Apr 4, 2024

Added

Added technology preview operation Fork iModel.

Added forkedFrom property to Get Create iModel Operation Details operation response.

Mar 29, 2024

Added

Added support for ordering collection by createdDateTime property in Get iModel Named Versions operation.

Added optional $search query parameter to Get iModel Named Versions operation.

Added ordering by createdDateTime for Get iTwin iModels operation.

Added technology preview operation Get iModel Role Permissions.

Added technology preview operation Update iModel Role Permissions.

Feb 20, 2024

Added

Added technology preview operation Create Changeset Extended Data.

Added technology preview operation Get Changeset Extended Data.

Added technology preview operation Get Changesets Extended Data.

Added technology preview operation Create iModel Changeset Group.

Added technology preview operation Get iModel Changeset Group.

Added technology preview operation Get iModel Changeset Groups.

Added technology preview operation Update iModel Changeset Group.

Added groupId property to Create iModel Changeset operation request body.

Added groupId property to Create iModel Changeset, Update iModel Changeset, Get iModel Changeset and Get iModel Changesets operation responses.

Added optional $search query parameter to Get iTwin iModels operation.

Jan 23, 2024

Added

Added dataCenterLocation property to Get iTwin iModels, Get iModel, Update-iModel and Create-iModel operation responses.

Jun 20, 2023

Added

Added isSecured property to Get iTwin iModels, Get iModel, Update-iModel and Create-iModel operation responses.

Nov 7, 2022

Announcement

iModels API version 2 is generally available

Aug 18, 2022

Added

Added operation Get iTwin iModels.

Changed

Create iModel operation now accepts iTwinId property and no longer accepts projectId property. iModels operations responses now contain iTwinId property and no longer contain projectId property.

Removed

Removed operation Get Project iModels.

Was this page helpful?