iTwin Platform
Get Started
Documentation
Learning
Samples
Blog
Support
Pricing
Sign In
Free Trial
Table of contents
v2
REST API Overview
Overview
Available Events
Tutorials
Samples
Reference
View All
Changelog
Documentation
iModels
iModels
Download API definition:
OpenAPI v3 (JSON)
API references
Call
Request URL
Title
Tags
POST
/imodels/{id}/briefcases
Acquire iModel Briefcase
Briefcases
POST
/imodels/{id}/clone
Clone iModel
iModels
POST
/imodels/{id}/baselinefile
Complete iModel Baseline File Upload
Baseline Files
POST
/imodels/{id}/changesets/{changeset}/extendeddata
Create Changeset Extended Data
Changesets
POST
/imodels/
Create iModel
iModels
POST
/imodels/{id}/changesets
Create iModel Changeset
Changesets
POST
/imodels/{id}/changesetgroups
Create iModel Changeset Group
Changeset Groups
POST
/imodels/{id}/namedversions
Create iModel Named Version
Named Versions
POST
/imodels/{id}/shares
Create iModel Share
Share
DELETE
/imodels/{id}
Delete iModel
iModels
GET
/imodels/{id}/thumbnail[?size]
Download iModel Thumbnail
Thumbnails
POST
/imodels/{id}/fork
Fork iModel
iModels
GET
/imodels/{id}/briefcases/checkpoint
Get Briefcase Checkpoint
Briefcases
GET
/imodels/{id}/changesets/{changeset}/checkpoint
Get Changeset Checkpoint
Changesets
GET
/imodels/{id}/changesets/{changeset}/extendeddata
Get Changeset Extended Data
Changesets
GET
/imodels/{id}/changesets/extendeddata
Get Changesets Extended Data
Changesets
GET
/imodels/{id}/operations/create
Get Create iModel Operation Details
Operations
GET
/imodels/{id}/namedversions/{namedVersionId}/checkpoint
Get Named Version Checkpoint
Named Versions
GET
/imodels/{id}
Get iModel
iModels
GET
/imodels/{id}/baselinefile
Get iModel Baseline File Details
Baseline Files
GET
/imodels/{id}/briefcases/{briefcaseId}
Get iModel Briefcase
Briefcases
GET
/imodels/{id}/briefcases[?$top][&$skip][&$orderBy][&ownerId]
Get iModel Briefcases
Briefcases
GET
/imodels/{id}/changesets/{changeset}
Get iModel Changeset
Changesets
GET
/imodels/{id}/changesetgroups/{changesetGroupId}
Get iModel Changeset Group
Changeset Groups
GET
/imodels/{id}/changesetgroups
Get iModel Changeset Groups
Changeset Groups
GET
/imodels/{id}/changesets[?$top][&$skip][&$orderBy][&afterIndex][&lastIndex]
Get iModel Changesets
Changesets
GET
/imodels/{id}/locks[?$skip][&$top][&briefcaseId][&lockLevel]
Get iModel Locks
Locks
GET
/imodels/{id}/namedversions/{namedVersionId}
Get iModel Named Version
Named Versions
GET
/imodels/{id}/namedversions[?$top][&$skip][&$orderBy][&$search][&name]
Get iModel Named Versions
Named Versions
GET
/imodels/{id}/permissions
Get iModel Permissions
Permissions
GET
/imodels/{id}/rolepermissions
Get iModel Role Permissions
Role Permissions
GET
/imodels/{id}/shares/{shareId}
Get iModel Share
Share
GET
/imodels/{id}/shares[?$top][&$skip]
Get iModel Shares
Share
GET
/imodels/{id}/users/{userId}
Get iModel User
Users
GET
/imodels/{id}/userpermissions
Get iModel User Permissions
User Permissions
GET
/imodels/{id}/users[?$top][&$skip][&$orderBy]
Get iModel Users
Users
GET
/imodels/?iTwinId[&$skip][&$top][&$orderBy][&$search][&name][&state]
Get iTwin iModels
iModels
DELETE
/imodels/{id}/briefcases/{briefcaseId}
Release iModel Briefcase
Briefcases
DELETE
/imodels/{id}/shares/{shareId}
Revoke iModel Share
Share
PATCH
/imodels/{id}
Update iModel
iModels
PATCH
/imodels/{id}/changesets/{changesetId}
Update iModel Changeset
Changesets
PATCH
/imodels/{id}/changesetgroups/{changesetGroupId}
Update iModel Changeset Group
Changeset Groups
PATCH
/imodels/{id}/locks
Update iModel Locks
Locks
PATCH
/imodels/{id}/namedversions/{namedVersionId}
Update iModel Named Version
Named Versions
PATCH
/imodels/{id}/rolepermissions
Update iModel Role Permissions
Role Permissions
PATCH
/imodels/{id}/shares/{shareId}
Update iModel Share
Share
PATCH
/imodels/{id}/userpermissions
Update iModel User Permissions
User Permissions
PUT
/imodels/{id}/thumbnail
Upload iModel Thumbnail
Thumbnails
Was this page helpful?
Yes
No