iModel transformations service

Perform transformations on iModels.


transformations

Added alwaysDrawn property for transformParams when creating filterByViewDefinition configuration.

Removed the technology preview from the get all transformations endpoint.

Added new documentation for transformation status

Added viewMode, hiddenModels and hiddenCategories transformation properties.

Added "Initializing" transformation status state

Added get all transformations endpoint which allows query transformations by configuration ID.

New property which specifies the type of transformation in configuration.

New transformation that allows to create fork iModel.

New transformation that allows to merge forked iModel.

Added new transformation 'AlignIModelData' which allows to remap data within the iModel and perform dynamic schema optimizations.

New transformation that allows the creation of new custom EC schemas and is capable of remapping already existing elements to the new EC classes with new EC properties.

New transformation allows you to combine physical models based on the EC query into physical models with specified names, added necessary policies and implemented tests.

Added property "simplifyGeometry" for CombinePhyscialModelsV2 transformation, which allows to simplify geometries inside the iModel for greater viewing optimization.

Added get all configurations endpoint which allows query configurations by project ID.

New transformation capable of merging multiple iModels support added

Added ability to include/filter out elements based on their model and category for FilterByViewDefinition transformation.

Added new configuration to run filterIModel transformation on iModels.

Added new configuration to run filterSubCategories transformation on iModels.

Added new properties for transformParams when creating filterByViewDefinition configuration (neverDrawn, subCategoryOvr and clip).

Initial technology preview release of the API.

---

This endpoint is used to create a configuration for align iModel data transformation.

Align iModel data transformation provides the capability of remapping element EClasses and their ECProperties, and performing modifications on **dynamic** ECSchemas. Dynamic schema modifications include the removal of unused ECClasses and merging multiple ECClasses into a single ECClass.

Configuration specific properties explained:

```
schemaOptimizationOptions - options that will modify ECSchemas.
    - removeUnusedClasses - if `true` ECClasses that have 0 elements will be removed from all **dynamic** ECSchemas.
    - classMergingGroups - array of ECClass merging group objects.
        - sourceECClasses - array of ECClass objects. Classes in this array will be merged into a single target ECClass. All class elements will also be remapped into the target ECClass.
            - ecClassName - ECClass name.
            - ecSchemaName - ECSchema name.
        - targetECClass - target ECClass. all sourceECClasses will be merged into this ECClass.
            - ecClassName - ECClass name.
            - ecSchemaName - ECSchema name.
dataRemappingOptions - options for data remapping.
    - additionalECSchemas - array of Bentley defined ECSchemas that will be imported into the target iModel
        - ecSchemaName - ECSchema name.
        - ecSchemaVersion - ECSchema version.
    - elementGroups - array of element group objects. Each object in the array defines a collection of elements to be mapped into a single target ECClass.
        - targetECClass - a target class for the elements selected by the `elementPropertyQuery` to be remapped into.
            - ecClassName - ECClass name.
            - ecSchemaName - ECSchema name.
        - elementPropertyQuery - ECSql query that selects element ECInstanceIds and any additional properties.
```

### Target ECClass

If `targetECClass` does not exist in the source iModel its schema must be imported using the `additionalECSchemas` property.

### Element Property query

The `elementPropertyQuery` must be a valid ECSql statement. The only requirement for the query is that it must select ECInstanceId column. Elements with these ids will be remapped into the `targetECClass`. Any additional column the query returns is treated as an additional property. Given that the additional property's column name and an ECProperty in the `targetECClass` name match, its value will be carried through and will be exported as that ECProperty's value in the target iModel. Column names for ECProperties are case insensitive.

#### Example

`ArchitecturalPhysical.Door` ECClass has 3 ECProperties defined - `OverallHeight`, `OverallWidth` and `Description`. To remap all `Generic.PhysicalObject` elements that have "door" in their UserLabel to an `ArchitecturalPhysical.Door` ECClass, a valid `elementPropertyQuery` would be:
- `SELECT ECInstanceId, 'This element was remapped from PhysicalObject' as Description, 15 as OverallHeight FROM Generic.PhysicalObject WHERE UserLabel LIKE '%door%'`

Remapped elements in the target iModel would have the following properties:
- Description: 'This element was remapped from PhysicalObject'
- OverallHeight: 15
- OverallWidth: NULL
- ...

Original properties will be carried through from the original element and any properties that do not exist in the target class will be lost.

To change already existing element property, select an already existing column. The following query will change all `BisCore.PhysicalObject` class element's user labels to 'Updated user label':
`SELECT ECInstanceId, 'Updated user label' as UserLabel FROM Generic.PhysicalObject`

**Note**: Creating a configuration does not run the transformation. To run the transformation, please see [transformations](/apis/transformations/operations/create-transformation/) 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](https://developer.bentley.com/apis/overview/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](apis/transformations/operations/get-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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---


alignimodeldata

OAuth access token with scope `transformations:modify`

Authorization

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

Accept

Returns the created configuration for align iModel data transformation.

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.

application/json;InvalidAuthorizationScheme

application/json;InvalidTransformationsRequest

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

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

retry-after

---

This endpoint is used to create CombineIModels configuration.

Combine IModels transformation combines the source iModel with iModels provided in transformation parameters.

Configuration specific properties explained:
```
iModels - list of iModels to combine the source iModel with.
 - iModelId - id of iModel
 - projectId - id of project that iModel belongs to
```
 
**Note**: Creating a configuration does not run the transformation. To run the transformation, please see [transformations](/apis/transformations/operations/create-transformation/) 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](https://developer.bentley.com/apis/overview/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](apis/transformations/operations/get-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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

combineimodels

---

This endpoint is used to create Combine Physical Models configuration.

Combine Physical Models transformation combines the source iModel's top level hierarchy physical models to a desired amount of models.
For more information see [iModel Information Hierarchy](https://www.itwinjs.org/bis/intro/information-hierarchy/#example-information-hierarchy).

This transformation is usually leveraged to improve performance of iModel viewers. Lack of performance is noticeable when model counts reach ~1000 or even more models.
It is recommended you set the `numberOfModels` property to ~ 5-20 and test the performance of the iModel.

Configuration specific properties explained:
```
numberOfModels - specify amount of models to transform the source iModel into.
simplifyGeometry - optional parameter indicating if geometry simplification should be used (transforming parasolids to meshes). Default if not specified - false.
```
 
**Note**: Creating a configuration does not run the transformation. To run the transformation, please see [transformations](/apis/transformations/operations/create-transformation/) 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](https://developer.bentley.com/apis/overview/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](apis/transformations/operations/get-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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

combinephysicalmodels

---

Use this endpoint to create CombinePhysicalModelsV2 configuration.

Combine Physical Models V2 transformation combines models in source iModel based on the EC query into target physical models with specified names. It is mandatory to only create source model queries which select ECInstanceId by using `*` or explicitly selecting that column. Also, source queries must pick only physical models that are sub-modeling physical partition.
For more information about internal iModel structure, see [Example Information Hierarchy](https://www.itwinjs.org/bis/intro/information-hierarchy/#example-information-hierarchy).

This transformation allows to optimize iModel for better viewing performance. You can notice lack of performance when model count reaches ~1000 or even more models.
You can select ~ 5-20 models by EC query and test the performance of the iModel.

Explanation of specific properties configuration.
```
modelGroups - property specifies an array of target model names with source model queries that you want to transform. This property is required.
groupUnselectedModels - optional parameter which indicates your decision on grouping unselected models. Default value is false.
unselectedModelsGroupName - optional parameter which sets name for unselected models group. You must specify the name if groupUnselectedModels is true.
simplifyGeometry - optional parameter indicating if geometry simplification should be used (transforming parasolids to meshes). Default if not specified - false.
```
 
**Note**: Creating a configuration does not run the transformation. To run the transformation, please see [transformations](/apis/transformations/operations/create-transformation/) 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](https://developer.bentley.com/apis/overview/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](apis/transformations/operations/get-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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

combinephysicalmodelsv2

The user has insufficient permissions for the requested operation.

---

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](/apis/imodels/operations/create-imodel/). 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](/apis/transformations/operations/create-transformation/) 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](https://developer.bentley.com/apis/overview/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](apis/transformations/operations/get-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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---


createfork

---

This endpoint is used to delete a configuration entity with a provided configurationId.

### 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](https://developer.bentley.com/apis/overview/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](apis/transformations/operations/get-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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---


delete-configuration

configurationId

Deletes the configuration for the given ID and returns it.

Configuration with the given ID does not exist.

---

This endpoint is used to create a configuration for filtering iModel data based on a view definition or a saved view.

Saved views are capable of displaying elements while hiding their parent elements. This cannot be achieved by filtering logic, because child elements cannot 'live' without their parent elements within an iModel. To workaround this misalignment between display and filtering logics, the transformations service does not filter out elements that have child elements that are visible within a view and only their geometries are deleted. This workaround only applies to filtering criteria related to categories and clipping data.

A View renders geometry from one or more Models of an iModel in a web browser. A View is an element of the ViewDefinition class. For more information, see [Using Views in iTwin.js](https://www.itwinjs.org/learning/frontend/views/).

This transformation is usually leveraged to filter out unnecessary data and align an iModel to the view within a browser window.

Configuration specific properties explained:

```
models - ids of enabled/visible models contained within a view definition.
hiddenModels - ids of disabled/hidden models contained within a view definition.
categories - ids of visible enabled/categories contained within a view definition.
hiddenCategories - ids of disabled/hidden categories contained within a view definition.
neverDrawn - element ids which should be left out of the target iModel.
alwaysDrawn - element ids which should be included in to the target iModel.
subCategoryOvr
    - subCategory - id of sub category 
    - invisible - geometry belonging to an invisible subCategory will be left out of target iModel
clip - data needed to create clipping. This cannot be an empty object.
    - shapes - array of shape clippings
        - points - array of number arrays describing the polygon. Each low level array contains numbers corresponding to coordinates [x, y, z]
        - trans - array of number arrays describing the transform applied to the polygon. Each low level array contains four numbers of a transform row [qx, qy, qz, ax].
        - zlow - lower bound on Z.
        - zhigh - upper bound on Z.
        - mask - `true` if this shape is a mask.
        - invisible -`true` if this shape is invisible.
    - planes - array of plane line clippings
        - invisible - `true` if this union of plane clip intersections is invisible.
        - clips - a union of plane clip set intersections
            - normal - the plane's inward normal as a number array corresponding to coordinates [x, y ,z].
            - dist - the plane's distance from the origin.
            - invisible - `true` if this plane is invisible.
            - interior - `true` if this plane is interior.
perModelCategoryVisibility - array of objects containing perModelCategoryVisibility data
    - modelId - id of model for which category override will apply.
    - categoryId - id of category for which the override will apply.
    - visible - boolean flag indicating if category is visible for the given model.
viewMode - enumerator that specifies the transformation saved view mode. It can have two values: IncludeNewContent and FilterContent.
    - IncludeNewContent includes all new content that was introduced into the iModel after the view was created.
    - FilterContent filters out all new content that was introduced into the iModel after the view was created.
```

All ids must be well-formed valid hexadecimal ids conforming with [iTwin.js specification](https://www.itwinjs.org/learning/common/id64/?term=id64).

PerModelCategoryVisibility override affects geometry on all subcategories belonging to the overridden category. That is, if the category is overridden to be visible, then geometry on all subcategories of the category will be visible, regardless of any subCategory overrides.

**Note**: Creating a configuration does not run the transformation. To run the transformation, please see [transformations](/apis/transformations/operations/create-transformation/) 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](https://developer.bentley.com/apis/overview/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](apis/transformations/operations/get-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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---


filterbyviewdefinition

Returns the created configuration for filtering by a view definition transformation.

---

This endpoint is used to create a configuration for filtering iModel data based on an ECSql query.

ECSQL is a text-based command language for CRUD (create, read, update, delete) operations against the business data in an iModel or ECDb file. For more information, samples and tutorials see [ECSQL](https://www.itwinjs.org/learning/ecsql/).

Configuration specific properties explained:

```
ecSql - ECSql query that only selects ECInstanceIds of elements that the iModel will be filtered by.
inclusive - 'false' when all elements selected by ecSql query are filtered out, 'true' when all physical elements that are not selected by ecSql query are filtered out. By default it is 'false'.
```
 
**Note**: Creating a configuration does not run the transformation. To run the transformation, please see [transformations](/apis/transformations/operations/create-transformation/) 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](https://developer.bentley.com/apis/overview/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](apis/transformations/operations/get-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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

filterimodel

Returns the created configuration for filtering iModel by ECSql query.

---

This endpoint is used to create a configuration for filtering out geometry entries based on their sub-category names.

A SubCategory is a subdivision of a Category. SubCategories allow elements in iModel to have multiple pieces of geometry that can be independently visible and styled (color, linesStyle, transparency, etc.). For more information, see [SubCategories](https://www.itwinjs.org/bis/intro/categories/#subcategories).

FilterSubCategories transformation is filtering out all of the data associated to subCategoryNames specified for the transformation.

Configuration specific properties explained:

```
subCategoryNames - array of sub category names.
```
 
**Note**: Creating a configuration does not run the transformation. To run the transformation, please see [transformations](/apis/transformations/operations/create-transformation/) 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](https://developer.bentley.com/apis/overview/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](apis/transformations/operations/get-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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

filtersubcategories

Returns the created configuration for filtering sub categories transformation.

---

This endpoint is used to query a list of configuration entities.

To get full configuration entities in a list set prefer header to `return=representation`.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `transformations:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

get-all-configurations

Source or target project ID of the configurations.

projectId

The `$top` query option requests the number of items in the queried collection to be included in the result. E.g. to return only first collection item provide the following query: `$top=1`. When $top parameter is not provided default is set to 100. `$top` value cannot exceed 1000.

$top

The `$skip` query option requests the number of items in the queried collection that are to be skipped and not included in the result. E.g. to return items from the collection starting at the third place provide the following query: `$skip=2`.

$skip

Indicates a level of details in the response. Valid values are `return=representation` or `return=minimal`. The default is `return=minimal`.

Prefer

OAuth access token with scope `transformations:read`

Returns configurations for the given project ID. If prefer header is not set, API will treat it as `return=minimal`.

Invalid request to get all configurations.

---

This endpoint is used to query a configuration entity with a provided configurationId.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `transformations:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

get-configuration

---

This endpoint is used to create the Group And Map configuration.

The Group And Map transformation enables the creation of new custom EC schemas and is capable of remapping already existing elements to the new EC classes with new EC properties. The custom schema is constructed using grouping and mapping data. It is your responsibility to create a valid mapping for the source iModel through [the Reporting API](/apis/insights/) before starting the transformation. To learn more about EC schemas and classes, please see [Base Infrastructure Schemas](https://www.itwinjs.org/bis/).

These are the logical relations from [grouping and mapping](/apis/insights/operations/create-mapping/) data to EC schema:
```
Mapping -> EC schema
Group -> EC class
GroupProperty -> EC property
```

After the transformation all elements that were *selected* with the group query will be remapped to the corresponding EC class. These elements will also have all the new EC properties inserted. The newly inserted EC properties' values will be populated with the help of 'ecProperties' field taken from the respective GroupProperty which you configured beforehand.

POST configuration specific properties explained:
```
mappingId - source iModel mapping id.
groupOverrides - list of overrides for each group.
 - groupId - id of mapping group.
 - baseClass - base EC class that will be applied for elements selected by group.
 - ecSchemaName - EC schema name.
 - ecClassName - EC class name.
additionalEcSchemas - list of additional EC schemas that will be added to target iModel.
 - ecSchemaName - EC schema name.
 - ecSchemaVersion - EC schema version.
```
 
**Note**: Creating a configuration does not run the transformation. To run the transformation, please see [transformations](/apis/transformations/operations/create-transformation/) 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](https://developer.bentley.com/apis/overview/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](apis/transformations/operations/get-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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

groupandmap

---

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](/apis/transformations/operations/createfork), [FilterIModel](/apis/transformations/operations/filterimodel), [FilterSubCategories](/apis/transformations/operations/filtersubcategories), [FilterByViewDefinition](/apis/transformations/operations/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.

```json
{
 "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](/apis/transformations/operations/create-transformation/) 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](https://developer.bentley.com/apis/overview/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](apis/transformations/operations/get-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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

mergefork

---

This endpoint is used to run the transformation based on an already created configuration. Sending a post request will submit a background processing job that is able to report progress back to the same transformation instance that you can query by the transformation ID.

First run of the transformation will process the whole source iModel and push data to the target iModel. 
Only one transformation job can run on the same target iModel at the same time.
Consecutively submitted jobs for the same configurationId will only process changes to the source iModel.

### Transformation status
Transformation `status` parameter provides information about the current status of a transformation. The status can have one of the following values:

- `Created` - this status is assigned when the transformation is created, but background job has not started yet. Once the background job is started, initialization begins.

- `Initializing` - a transformation in the `Initializing` status means that the background job has been started and is preparing to run the transformation. This process involves downloading all the necessary iModels and setting up other parameters as required by the transformation.

- `Started` - when the transformation background job starts processing the iModel elements based on the transformation configuration, the status changes to `Started`. You can monitor the progress of the transformation during this stage by tracking the count of processed elements. This count allows you to estimate when the transformation might finish.

- `Succeeded` - upon successful completion of the transformation, the status is set to `Succeeded`. This means all iModel elements have been processed as per the transformation configuration without any errors.

- `Failed` - if an error occurs during the transformation process (while in the `Initializing` or `Started` statuses), the status changes to `Failed`. This indicates that the transformation has ended prematurely and would leave the target iModel in an invalid state if any intermediate changes were pushed. If the transformation is in an invalid state, it is necessary to use a new target iModel in order to proceed with further transformations.

- `Aborted` - a transformation is labeled as `Aborted` when it is manually cancelled by the user. Note that a transformation cannot be cancelled if it has already finished (its status is either `Failed` or `Succeeded`).

### 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](https://developer.bentley.com/apis/overview/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](apis/transformations/operations/get-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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

### Transformation Element Limiting

When you run a transformation with the "Try it out" function, you are limited to transforming iModels with up to 1000 entities, which includes elements and relationships. For more information about entities, see [Element Fundamentals](https://www.itwinjs.org/bis/guide/fundamentals/element-fundamentals/) and [Relationship Fundamentals](https://www.itwinjs.org/bis/guide/fundamentals/relationship-fundamentals/). If an iModel has more than 1000 entities, transformation will not succeed. To transform iModels without any limits, please generate authorization for a different client and call this endpoint directly or add the newly generated authorization value to a `Authorization` field. For more information about using your own client, see [Authorize Service](https://developer.bentley.com/tutorials/authorize-service).

---


create-transformation

If there is an ongoing transformation with target iModel or configuration does not exist or transformation could not be started.

---

This endpoint is used to delete an ongoing transformation for a provided transformationId.

### 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](https://developer.bentley.com/apis/overview/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](apis/transformations/operations/get-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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---


delete-transformation

transformationId

Returns deleted transformation with the given ID.

Transformation with the given ID does not exist.

---

This endpoint is used to query a list of transformation entities.

To get full transformation entities in a list set prefer header to `return=representation`.

### Transformation status
Transformation `status` parameter provides information about the current status of a transformation. The status can have one of the following values:

- `Created` - this status is assigned when the transformation is created, but background job has not started yet. Once the background job is started, initialization begins.

- `Initializing` - a transformation in the `Initializing` status means that the background job has been started and is preparing to run the transformation. This process involves downloading all the necessary iModels and setting up other parameters as required by the transformation.

- `Started` - when the transformation background job starts processing the iModel elements based on the transformation configuration, the status changes to `Started`. You can monitor the progress of the transformation during this stage by tracking the count of processed elements. This count allows you to estimate when the transformation might finish.

- `Succeeded` - upon successful completion of the transformation, the status is set to `Succeeded`. This means all iModel elements have been processed as per the transformation configuration without any errors.

- `Failed` - if an error occurs during the transformation process (while in the `Initializing` or `Started` statuses), the status changes to `Failed`. This indicates that the transformation has ended prematurely and would leave the target iModel in an invalid state if any intermediate changes were pushed. If the transformation is in an invalid state, it is necessary to use a new target iModel in order to proceed with further transformations.

- `Aborted` - a transformation is labeled as `Aborted` when it is manually cancelled by the user. Note that a transformation cannot be cancelled if it has already finished (its status is either `Failed` or `Succeeded`).

### Authentication

Requires `Authorization` header with valid Bearer token for scope `transformations:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

get-all-transformations

Specify a particular transformation status that you wish to query on.

Status

The OrderBy query option allows clients to request ascending or descending using `_desc` order of the returned collection by one of the item properties. We support sorting by every property that is present in response body. When `_desc` keyword is not specified the collection is sorted in ascending order. To sort the collection in descending order provide `_desc` keyword e.g.: `OrderBy=finishedDateTime_desc`.

OrderBy

The `$top` query option requests the number of items in the queried collection to be included in the result. E.g. to return only first collection item provide the following query: `$top=1`. When `$top` parameter is not provided default is set to 100. `$top` value cannot exceed 1000.

Returns transformations for the given configuration ID. If prefer header is not set, API will treat it as `return=minimal`.

Invalid request to get all transformations.

---

This endpoint is used to track progress of a transformation for a provided transformationId.

### Transformation status
Transformation `status` parameter provides information about the current status of a transformation. The status can have one of the following values:

- `Created` - this status is assigned when the transformation is created, but background job has not started yet. Once the background job is started, initialization begins.

- `Initializing` - a transformation in the `Initializing` status means that the background job has been started and is preparing to run the transformation. This process involves downloading all the necessary iModels and setting up other parameters as required by the transformation.

- `Started` - when the transformation background job starts processing the iModel elements based on the transformation configuration, the status changes to `Started`. You can monitor the progress of the transformation during this stage by tracking the count of processed elements. This count allows you to estimate when the transformation might finish.

- `Succeeded` - upon successful completion of the transformation, the status is set to `Succeeded`. This means all iModel elements have been processed as per the transformation configuration without any errors.

- `Failed` - if an error occurs during the transformation process (while in the `Initializing` or `Started` statuses), the status changes to `Failed`. This indicates that the transformation has ended prematurely and would leave the target iModel in an invalid state if any intermediate changes were pushed. If the transformation is in an invalid state, it is necessary to use a new target iModel in order to proceed with further transformations.

- `Aborted` - a transformation is labeled as `Aborted` when it is manually cancelled by the user. Note that a transformation cannot be cancelled if it has already finished (its status is either `Failed` or `Succeeded`).

### Authentication

Requires `Authorization` header with valid Bearer token for scope `transformations:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

get-transformation

Returns transformation with the given ID.

Changelog - Transformations | iTwin Platform

This tutorial will demonstrate how to filter an iModel by a view definition using iModel Transformations API.

Transforming an iModel - Filtering data by a view definition

This tutorial will demonstrate how to combine physical models in second version using iModel Transformations API.

Transforming an iModel - Combining physical models

Transforming an iModel - Combining physical models v2

This tutorial will create a forked iModel and merge it back into the main iModel

Changelog

Jul 26, 2023

May 19, 2023

Mar 27, 2023

Mar 13, 2023

Nov 17, 2022

Nov 8, 2022

Oct 10, 2022

Sep 28, 2022

Aug 1, 2022

Apr 27, 2022

Nov 30, 2021

Oct 28, 2021

Oct 20, 2021

Aug 6, 2021