Fork iModel - iModels | iTwin Platform

REST API Overview

Reference

iModels

Download API definition:

This operation is a Technical Preview and is available for testing purposes only. Do not use in production.

POST https://api.bentley.com/imodels/{id}/fork

Creates an iModel Fork. An iModel Fork is a new iModel which is a full or partial clone of the source iModel, but the difference between an iModel Fork and an iModel clone is that Fork iModels can be edited and then merged back to the source iModel.

Relationship between source and Fork iModels

An iModel Fork is a valid standalone iModel. An iModel Fork is not deleted if the source iModel is deleted.

When the iModel forking process is completed, no new changes are synchronized to the iModel Fork from the source iModel.

iModel Create Operation Details operation can be used to determine if the current iModel is a Fork.

iModel Fork content and metadata

The iModel Fork name and description can be specified when forking 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 iModel Fork. User can specify until which point Changesets should be copied to the iModel Fork, by default all source iModel Changesets are copied. The rest of source iModel entities are not copied.

Operation state

Forking an 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 iModel Fork. When the iModel Fork's Create Operation state property is set to successful it means the forking process is complete and iModel is ready to be used.

`sourceIsMissingFederationGuids` state

If state returned by Get Create iModel Operation details is equal to sourceIsMissingFederationGuids, it means that iModel Fork creation failed because some elements in the source iModel do not have FederationGuid property set. In order to proceed users must populate missing FederationGuid values and retry the iModel Fork creation request.

Authentication

Requires Authorization header with valid Bearer token for scope itwin-platform.

For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.

Authorization

User must have the following permissions:

imodels_manage permission at the source iModel iTwin level.
imodels_manage permission at the iTwin, in which the iModel Fork will be created, level.

If source iModel has iModel level permissions configured, then user must have at least imodels_webview permission assigned.

Alternatively the user should be an Organization Administrator both for the Organization that owns source iModel iTwin and the Organization that owns the Fork iModel 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.

Important: Fork iModel operation is in closed preview mode currently and only selected applications can utilize it.

Rate limits

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.

Trial

5 calls per minute

Basic, Premium, Enterprise

20 calls per minute

Request

Request parameters

template

Yes

iModel id

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

Setting to application/vnd.bentley.itwin-platform.v2+json is recommended.

Request body

ForkiModel (ChangesetId)

iTwinId

String

Yes

Id of the iTwin in which the new iModel will be created.

changesetId

String,null

Id of the latest source iModel Changeset that should be copied to the iModel Fork. Changeset can also be specified using an index, see changesetIndex property. If neither changesetId nor changesetIndex are provided, all existing source iModel Changesets are copied to the iModel Fork. If "changesetId": "" is specified, no Changesets are copied to the iModel Fork, only source iModel Baseline is copied.

changesetIndex

Int64

Index of the latest source iModel Changeset that should be copied to the iModel Fork. Changeset can also be specified using an id, see changesetId property. If neither changesetId nor changesetIndex are provided, all existing source iModel Changesets are copied to the iModel Fork. If "changesetIndex": 0 is specified, no Changesets are copied to the iModel Fork, only source iModel Baseline is copied. Valid changesetIndex values are non-negative integers.

name

String,null

Name of the iModel that will be created. If name is not provided, source iModel name will be used. iModel name must be unique within the iTwin. Valid name values are non-empty strings that are not longer than 255 characters.

description

String,null

Description of the iModel that will be created. If description is not provided, source iModel description will be used. Valid description values are non-empty strings that are not longer than 255 characters.

preserveHistory

Boolean,null

Option to control how Changesets are copied from the source iModel to the iModel Fork. If set to true, Changesets will be copied individually and the history will be preserved. If set to false, Changesets will be squashed and applied to the Baseline resulting in an iModel Fork without Changeset history. The default value is false.

Example

json

{
    "iTwinId": "98418aa0-9059-458b-b9e4-245cf6131a55",
    "changesetId": "1f2e04b666edce395e37a795e2231e995cbf8349",
    "name": "Target iModel name",
    "description": "Target iModel description",
    "preserveHistory": true
}

ForkiModel (ChangesetIndex)

iTwinId

String

Yes

Id of the iTwin in which the new iModel will be created.

changesetId

String,null

Id of the latest source iModel Changeset that should be copied to the iModel Fork. Changeset can also be specified using an index, see changesetIndex property. If neither changesetId nor changesetIndex are provided, all existing source iModel Changesets are copied to the iModel Fork. If "changesetId": "" is specified, no Changesets are copied to the iModel Fork, only source iModel Baseline is copied.

changesetIndex

Int64

Index of the latest source iModel Changeset that should be copied to the iModel Fork. Changeset can also be specified using an id, see changesetId property. If neither changesetId nor changesetIndex are provided, all existing source iModel Changesets are copied to the iModel Fork. If "changesetIndex": 0 is specified, no Changesets are copied to the iModel Fork, only source iModel Baseline is copied. Valid changesetIndex values are non-negative integers.

name

String,null

Name of the iModel that will be created. If name is not provided, source iModel name will be used. iModel name must be unique within the iTwin. Valid name values are non-empty strings that are not longer than 255 characters.

description

String,null

Description of the iModel that will be created. If description is not provided, source iModel description will be used. Valid description values are non-empty strings that are not longer than 255 characters.

preserveHistory

Boolean,null

Option to control how Changesets are copied from the source iModel to the iModel Fork. If set to true, Changesets will be copied individually and the history will be preserved. If set to false, Changesets will be squashed and applied to the Baseline resulting in an iModel Fork without Changeset history. The default value is false.

Example

json

{
    "iTwinId": "98418aa0-9059-458b-b9e4-245cf6131a55",
    "changesetIndex": 5
}

ForkiModel (iTwinIdOnly)

iTwinId

String

Yes

Id of the iTwin in which the new iModel will be created.

changesetId

String,null

Id of the latest source iModel Changeset that should be copied to the iModel Fork. Changeset can also be specified using an index, see changesetIndex property. If neither changesetId nor changesetIndex are provided, all existing source iModel Changesets are copied to the iModel Fork. If "changesetId": "" is specified, no Changesets are copied to the iModel Fork, only source iModel Baseline is copied.

changesetIndex

Int64

Index of the latest source iModel Changeset that should be copied to the iModel Fork. Changeset can also be specified using an id, see changesetId property. If neither changesetId nor changesetIndex are provided, all existing source iModel Changesets are copied to the iModel Fork. If "changesetIndex": 0 is specified, no Changesets are copied to the iModel Fork, only source iModel Baseline is copied. Valid changesetIndex values are non-negative integers.

name

String,null

Name of the iModel that will be created. If name is not provided, source iModel name will be used. iModel name must be unique within the iTwin. Valid name values are non-empty strings that are not longer than 255 characters.

description

String,null

Description of the iModel that will be created. If description is not provided, source iModel description will be used. Valid description values are non-empty strings that are not longer than 255 characters.

preserveHistory

Boolean,null

Option to control how Changesets are copied from the source iModel to the iModel Fork. If set to true, Changesets will be copied individually and the history will be preserved. If set to false, Changesets will be squashed and applied to the Baseline resulting in an iModel Fork without Changeset history. The default value is false.

Example

json

{
    "iTwinId": "98418aa0-9059-458b-b9e4-245cf6131a55"
}

Response

Response 202 Accepted

Accepted

Response headers

Location

The resource location which is a URL to the new iModel.

Create-iModel-Operation

A URL which points to Get Create iModel Operation details endpoint for the new iModel.

Response 401 Unauthorized

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.

json

{
    "error": {
        "code": "HeaderNotFound",
        "message": "Header Authorization was not found in the request. Access denied."
    }
}

Response 403 Forbidden

User is not authorized to fork iModel.

json

{
    "error": {
        "code": "InsufficientPermissions",
        "message": "The user has insufficient permissions for the requested operation."
    }
}

Response 404 Not Found

Specified source iTwin, iModel or Changeset were not found.

json

{
    "error": {
        "code": "iTwinNotFound",
        "message": "Requested iTwin is not available."
    }
}

Response 409 Conflict

iModel with the same name already exists in the iTwin or the source iModel is not initialized.

json

{
    "error": {
        "code": "iModelExists",
        "message": "iModel with the same name already exists within the iTwin."
    }
}

Response 422 Unprocessable Entity

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)

json

{
    "error": {
        "code": "InvalidiModelsRequest",
        "message": "Cannot fork iModel.",
        "details": [{
                "code": "InvalidHeaderValue",
                "message": "'application/xml' is not supported 'content-type'. Supported media type is 'application/json'.",
                "target": "content-type"
            },
            {
                "code": "InvalidRequestBody",
                "message": "Failed to parse request body. Make sure it is a valid JSON."
            },
            {
                "code": "MissingRequiredProperty",
                "message": "Required property is missing.",
                "target": "iTwinId"
            },
            {
                "code": "InvalidValue",
                "message": "'' is not a valid 'name' value. The value cannot be empty or consist only of whitespace characters.",
                "target": "name"
            }
        ]
    }
}

Response 429 Too many requests

This response indicates that the user has sent too many requests in a given amount of time.

json

{
    "error": {
        "code": "TooManyRequests",
        "message": "More requests were received than the subscription rate-limit allows."
    }
}

Response headers

retry-after

The number of requests exceeds the rate-limit for the client subscription.

Definitions

Fork iModel Request

Information that should be provided to start iModel Fork creation.

TableSchema

iTwinId

String

Id of the iTwin in which the new iModel will be created.

changesetId

String,null

Id of the latest source iModel Changeset that should be copied to the iModel Fork. Changeset can also be specified using an index, see changesetIndex property. If neither changesetId nor changesetIndex are provided, all existing source iModel Changesets are copied to the iModel Fork. If "changesetId": "" is specified, no Changesets are copied to the iModel Fork, only source iModel Baseline is copied.

changesetIndex

Int64

Index of the latest source iModel Changeset that should be copied to the iModel Fork. Changeset can also be specified using an id, see changesetId property. If neither changesetId nor changesetIndex are provided, all existing source iModel Changesets are copied to the iModel Fork. If "changesetIndex": 0 is specified, no Changesets are copied to the iModel Fork, only source iModel Baseline is copied. Valid changesetIndex values are non-negative integers.

name

String,null

Name of the iModel that will be created. If name is not provided, source iModel name will be used. iModel name must be unique within the iTwin. Valid name values are non-empty strings that are not longer than 255 characters.

description

String,null

Description of the iModel that will be created. If description is not provided, source iModel description will be used. Valid description values are non-empty strings that are not longer than 255 characters.

preserveHistory

Boolean,null

Option to control how Changesets are copied from the source iModel to the iModel Fork. If set to true, Changesets will be copied individually and the history will be preserved. If set to false, Changesets will be squashed and applied to the Baseline resulting in an iModel Fork without Changeset history. The default value is false.

Error

Contains error information.

TableSchema

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String

The target of the error.

Error Response

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.

TableSchema

error

Error

Error information.