Table of contents
Transformations

Configurations

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/transformations/configurations/mergefork

This endpoint allows to create a configuration for merge fork transformation.

MergeFork transformation allows to merge back the forked iModel into the main iModel. Forked iModel must be created using one of CreateFork, FilterIModel, FilterSubCategories, FilterByViewDefinition transformation and it must have at least one new changeset with modifications for merging to succeed.

To configure MergeFork configuration correctly, you will need to pass the configuration ID of the configuration that was used to create the forked iModel in the transform parameters. Then the source iModel of that configuration becomes the target, and the target iModel will have to be the source. So source project and iModel ids should point to the forked iModel and target project and iModel information should refer to the main iModel.

{
    "sourceProjectId": "00000000-0000-0000-0000-000000000000", // forked iModel's project id
    "sourceIModelId": "00000000-0000-0000-0000-000000000000",  // forked iModel's id
    "targetProjectId": "00000000-0000-0000-0000-000000000000", // main iModel's project id
    "targetIModelId": "00000000-0000-0000-0000-000000000000",  // main iModel's id
    "transformParameters": {
        "configurationId": "00000000-0000-0000-0000-000000000000" // configuration id of CreateFork configuration
    }

Explanation of specific properties configuration.

configurationId - required property that specifies configuration id, which was used to fork the main iModel.

If you want to transform new changes in the forked iModel after you merge it back into the main iModel, use the same configuration that was created by this endpoint.
Note: Creating a configuration does not run the transformation. To run the transformation, please see transformations reference.

Authentication

Requires Authorization header with valid Bearer token for scope transformations:modify.

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

Authorization

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.

Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit Rate limits and quotas page.

Request headers

Name
Required?
Description
Authorization
Yes

OAuth access token with scope transformations:modify

Accept
No

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

Request body

Create MergeFork configuration

Name
Type
Required?
Description
transformName
String
Yes

User friendly name of the transformation.

sourceProjectId
String
Yes

ID of the source iModel.

sourceIModelId
String
Yes

ID of the source iModel.

targetProjectId
String
Yes

ID of the target iModel.

targetIModelId
String
Yes

ID of the target iModel.

comment
String
Yes

Comment for the changeset created after transformation.

transformType
String
Yes

Type of the transformation.

transformParameters
Yes

Merge fork configuration transform parameters

Example

json

Response 201 Created

Returns the created configuration.

json

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

Response 403 Forbidden

The user has insufficient permissions for the requested operation.

json

Response 422 Unprocessable Entity

Given data is invalid.

json

Response 429 Too many requests

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

json

Response headers

Name
Description
retry-after

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

Create MergeFork configuration

Data needed to create MergeFork configuration.

TableSchema
Name
Type
Description
transformName
String

User friendly name of the transformation.

sourceProjectId
String

ID of the source iModel.

sourceIModelId
String

ID of the source iModel.

targetProjectId
String

ID of the target iModel.

targetIModelId
String

ID of the target iModel.

comment
String

Comment for the changeset created after transformation.

transformType
String

Type of the transformation.

transformParameters

Merge fork configuration transform parameters

Merge fork configuration

TableSchema
Name
Type
Description
configurationId
String

Required property that specifies configuration id, which was used to connect duplicate iModel to the main iModel.

Merge fork configuration transform parameters links

TableSchema
Name
Type
Description
configuration

Merge fork configuration

TableSchema
Name
Type
Description
configuration

Merge fork configuration object.

Merge fork configuration properties

TableSchema
Name
Type
Description
id
String

ID of the configuration.

transformName
String

User friendly name of the transformation.

comment
String

Comment for the changeset created after transformation.

createdDateTime
Date-time

Time the configuration was created at.

modifiedDateTime
Date-time

Time the configuration was last modified at.

transformType
String

Type of the transformation.

transformParameters

Merge fork configuration transform parameters.

_links

Links to a configuration data.

Links

TableSchema
Name
Type
Description
sourceIModel

Link to a source iModel.

targetIModel

Link to a target iModel.

sourceProject

Link to a source project.

targetProject

Link to a target project.

Link

TableSchema
Name
Type
Description
href
String

Link to a resource.

Error

Contains error information and an optional array of more specific errors.

TableSchema
Name
Type
Description
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
Name
Type
Description
error

Error information.