Creates an iModel. There are three different ways to create an iModel.
To create an empty iModel do not provide
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.
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:
Create a new iModel and provide
baselineFileproperty. It is important to provide correct file size or the iModel creation will fail in the later steps.
Upload Baseline File to blob storage using
uploadproperty link from the response of iModel creation.
Request syntax: PUT upload HTTP/1.1 Request headers: x-ms-blob-type: BlockBlob
- Complete the iModel creation by confirming that Baseline File was uploaded successfully. See Complete iModel Baseline Upload operation for the documentation.
When creating an empty iModel it will be initialized immediately. When creating an iModel using
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 operation.
Authorization header with valid Bearer token for scope
For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.
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 wiki page.
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.
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 create an iModel.
Specified iTwin was not found.
iModel with the same name already exists within the iTwin.
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)
Container for iModel object.
Full representation of the iModel.
Properties of the iModel to be created.
Used for specifying the iModel template during iModel creation.
Used for describing Baseline File during iModel creation.
Hyperlinks to related data which complements this entity.
A rectangular area on the Earth. A rectangular area is defined by two latitudes and two longitudes that represent the four sides of a rectangular area on the Earth.
A point on the Earth specified by a latitude and longitude.
Contains error information.
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.