This endpoint is used to create a CreateFork configuration.
Create fork transformation allows connecting the cloned iModel to the main iModel for merging back the changes later on. Once transformation is finished the forked iModel is ready for modifications.
This transformation expects that the source and target iModels are duplicates. You can copy the existing iModel using iModels API's create iModel endpoint. After it's done, source project and iModel should come from the main iModel and target project and iModel should come from the forked iModel.
Note: Creating a configuration does not run the transformation. To run the transformation, please see transformations reference.
Authorization header with valid Bearer token for scope
For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.
You must have
imodels_write assigned at the target project level and
imodels_read assigned at the source project level within related configuration. If permissions at the project level are not configured, then you must have same assigned at the iModel level.
Alternatively, you must be an Organization Administrator for the Organization that owns a given project the iModel belongs to.
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 see Bentley Communities Licensing, Cloud, and Web Services wiki page.
All iTwin Platform API operations have a rate limit. For more documentation on that visit Rate limits and quotas page.
Returns the created configuration.
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.
If user has insufficient permissions.
Given data is invalid.
Data needed to create CreateFork configuration.
Contains error information and an optional array of more specific errors.
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.