Clones the specified iModel.
Cloning an iModel means that a new iModel is created by importing data from the source iModel. That new iModel is considered to be an iModel clone. Id of the source iModel is specified in the request url while the id of the target iTwin which will contain the new iModel is specified in the request body.
iModel clone is a valid standalone iModel. After the iModel cloning process is completed, no new changes are synchronized to the iModel clone from the source iModel. iModel clone is not deleted if the source iModel is deleted.
The target iModel name and description can be specified when cloning an iModel, by default name and description are taken from the source iModel. iModel extent is always taken from the source iModel.
iModel Baseline is always copied from the source iModel to the target iModel. User can specify until which point Changesets should be copied to the target iModel, by default all source iModel Changesets are copied. The rest of source iModel entities are not copied.
Clone iModel is an asynchronous operation. To check the status of the operation please follow the link present in
Create-iModel-Operation response header. The link points to Get Create iModel Operation details endpoint of the target iModel. When the target iModel's Create Operation
state property is set to
successful it means the cloning process is complete and iModel is ready to be used.
Location header value is a link to Get iModel details endpoint of the target iModel which provides metadata about the the target iModel as well as when it is ready to be used. When target iModel's
state property is set to
initialized the iModel is ready to be used.
Please note that iModel may be marked as
initialized before the iModel Create Operation is marked as
successful. Such behavior allows target iModel to be utilized faster. The cloning background process first of all copies the critical iModel data and marks the iModel as
initialized, and then copies additional data used to improve performance for iModel viewing and authoring workflows.
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 following permissions:
imodels_managepermission at the source iModel iTwin level.
imodels_managepermission at the target iTwin level.
If source iModel has iModel level permissions configured, then user must have at least
imodels_webview permission assigned at iModel level.
Alternatively the user should be an Organization Administrator both for the Organization that owns source iModel iTwin and the Organization that owns target 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 clone iModel.
Specified source iTwin, iModel or Changeset were not found.
iModel with the same name already exists in the iTwin or the source iModel is not initialized.
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)
Information that should be provided to start iModel cloning.
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.