Table of contents
iModels

Changelog

Jul 24, 2026

Added

Added the Get iModel Released Locks operation.

May 19, 2026

Added

Added a size property to the checkpoint.

Apr 13, 2026

Added

Added the Release iModel Locks Chunk operation.

Mar 25, 2026

Added

Added a lastChangesetPushDateTime property to the full representation of an iModel in operation responses.

Changed

Renamed changedElements to elementIds, and switched to using DirectoryAccessInfo.

Oct 29, 2025

Added

Added the Remove iModel from My Recents operation.

Aug 14, 2025

Removed

Removed the technology preview iModel sharing operations.

  • Create iModel Share
  • Get iModel Share
  • Get iModel Shares
  • Update iModel Share
  • Revoke iModel Share

Aug 12, 2025

Added

Added technology preview operations for a user's recently used iModels.

  • Add iModel to My Recents
  • Get My Recently Used iTwin iModels

Aug 5, 2025

Added

Added technology preview operations for a user's favorite iModels.

  • Add iModel To My Favorites
  • Get My Favorite iTwin iModels
  • Remove iModel From My Favorites

May 19, 2025

Added

Added the Update Named Version Checkpoint operation.

May 13, 2025

Added

Added an applications property to the Get iModel Users and Get iModel User operation responses.

Mar 18, 2025

Added

Added an 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.

Announcement

The $skip query parameter on Get iModel Briefcases, Get iModel Changesets, Get iModel Locks, Get iModel Named Versions, Get iModel Users, and Get iTwin iModels is deprecated and will be removed in a future API version — use $continuationToken instead.

Feb 27, 2025

Added

Added optional creationMode and geographicCoordinateSystem properties to Create iModel.

Announcement

Create iModel now accepts an optional creationMode property, which will become required in a future API version. Creating an empty, instantly-initialized iModel without specifying it is deprecated and may be removed later.

Feb 26, 2025

Added

Added directoryAccessInfo and dbName properties to the Get Changeset Checkpoint, Get Briefcase Checkpoint, and Get Named Version Checkpoint responses, and a storageType property to all upload/download links.

Announcement

The containerAccessInfo property on Get Changeset Checkpoint, Get Briefcase Checkpoint, and Get Named Version Checkpoint is deprecated in favor of directoryAccessInfo and will be removed in a future API version.

Sep 23, 2024

Announcement

The LastAccessTime property on Get iModel Users and Get iModel User is deprecated and will be removed in a future API version.

May 14, 2024

Added

Added technology preview operations for managing an iModel user's permissions.

  • Get iModel User Permissions
  • Update iModel User Permissions

Apr 22, 2024

Added

Added the technology preview Get Briefcase Checkpoint operation.

Apr 4, 2024

Added

Added the technology preview Fork iModel operation, and a forkedFrom property to the Get Create iModel Operation Details response.

Mar 29, 2024

Added

Added technology preview operations for managing an iModel role's permissions.

  • Get iModel Role Permissions
  • Update iModel Role Permissions

Mar 25, 2024

Added

Added support for ordering Get iTwin iModels results by createdDateTime.

Mar 8, 2024

Added

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

Feb 29, 2024

Added

Added support for ordering Get iModel Named Versions results by createdDateTime.

Feb 20, 2024

Added

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

Feb 15, 2024

Added

Added a groupId property to the Create iModel Changeset request, and to the Create iModel Changeset, Update iModel Changeset, Get iModel Changeset Details, and Get iModel Changesets responses.

Feb 9, 2024

Added

Added the technology preview Update iModel Changeset Group operation.

Feb 7, 2024

Added

Added technology preview operations for iModel changeset groups.

  • Create iModel Changeset Group
  • Get iModel Changeset Group
  • Get iModel Changeset Groups

Jan 24, 2024

Added

Added technology preview operations for changeset extended data.

  • Create Changeset Extended Data
  • Get Changeset Extended Data
  • Get Changesets Extended Data

Jan 23, 2024

Added

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

Jun 20, 2023

Added

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

Nov 7, 2022

Announcement

iModels API version 2 is generally available.

Aug 18, 2022

Removed

Removed the Get Project iModels operation.

Aug 17, 2022

Changed

Create iModel now accepts an iTwinId property instead of projectId, and iModel operation responses now contain iTwinId instead of projectId.

Aug 16, 2022

Added

Added the Get iTwin iModels operation.

Was this page helpful?