iModel transformations service

Perform transformations on iModels.

transformations

## Transformations API

The Transformations API is a service that provides an ability to transform iModel data.
A transformation process is always happening between 2 iModels. A source iModel is used as a transformation source and target iModel is used as a placeholder for transformed data.

Transformation API features:

- Filtering based on a view definition.
- Progress reporting.
- History tracking.
- Transforming changes.

Use cases:

- Project collaborators are interested in only a specific part of a project. Transformations API might be used to filter out data and produce a targeted data set.

### View Definition

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. More information [here](https://www.itwinjs.org/learning/frontend/views/)


---

This endpoint is used to create CombinePhysicalModels configuration.

Combine Physical Models transformation combines the source iModel's top level hierarchy physical models to a desired amount of models.
More information about internal iModel structure can be found [here](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 to 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.
```

Creating a configuration does not actually run the transformation. To run the transformation check out POST [/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

User must have `imodels_write` permission assigned at the iModel level and at least `imodels_webview` permission assigned at the Project level. If permissions at the iModel level are not configured, then user must have `imodels_write` permission assigned at the Project level.

Alternatively the user should 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 please visit our 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.

---


combinephysicalmodels

OAuth access token with scope `transformations:modify`

Authorization

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

Accept

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;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 a configuration for filtering iModel data based on a view definition.

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. More information [here](https://www.itwinjs.org/learning/frontend/views/).

FilterByViewDefinition transformation is filtering out all of the data not associated to the models and categories specified for the transformation.

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 models contained within a view definition.
categories - ids of categories contained within a view definition.
neverDrawn - element ids which should be left out of 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.
    - 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 4 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 -
        - 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.
        
```

All ids must be well-formed valid hexadecimal ids conforming with [iTwin.js specification](https://www.itwinjs.org/learning/common/id64/?term=id64).

Creating a configuration does not actually run the transformation. To run the transformation check out POST [/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

User must have `imodels_write` permission assigned at the iModel level and at least `imodels_webview` permission assigned at the Project level. If permissions at the iModel level are not configured, then user must have `imodels_write` permission assigned at the Project level.

Alternatively the user should 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 please visit our 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 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.). More information [here](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.
```

Creating a configuration does not actually run the transformation. To run the transformation check out POST [/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

User must have `imodels_write` permission assigned at the iModel level and at least `imodels_webview` permission assigned at the Project level. If permissions at the iModel level are not configured, then user must have `imodels_write` permission assigned at the Project level.

Alternatively the user should 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 please visit our 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 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.

---

get-configuration

configurationId

OAuth access token with scope `transformations:read`

Configuration with the given ID does not exist.

---

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.

### 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.

---


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 track progress of a transformation for a provided transformationId.

### 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.

---

get-transformation

transformationId

Returns transformation with the given ID.

Transformation with the given ID does not exist.

View and interact with your iTwin in a web browser using Bentley cloud services.


visualization

Export engineering design data from iModels to other formats like IFC or LandXML.


export

Synchronize engineering design data from native formats to web-viewable iTwins.


synchronization

Transform Engineering Data for Data Alignment or Performance Improvements


Coordinate concurrent access to iModels and track the timeline of engineering changes.


imodels

Manage and publish catalogs of approved digital components.


library

Securely store 3D scalable meshes, point clouds, and photos.


reality-data

storage

Manage projects associated with your iTwin.


projects

Manage users who interact with your iTwin.


users

Convert photos into high resolution 3D reality meshes.


contextcapture

Detect collisions and check clearance between geometric elements.


clash-detection

The Classification Validation API allows you to manage classification validation tests, runs, and results. You can run tests and monitor the progress.

classification-validation

The Property Validation API allows you to manage property value validation rules, tests, runs, and results. You can run tests and monitor the progress.

validation

Access the Design Element Classification machine learning model.


designelementclassification

Build custom dashboards and integrate iTwin data with other business applications.


insights

Compare engineering design versions and identify elements that changed.


changed-elements

Store, manage, and access field data in the cloud.


forms

Create, analyze, and prioritize issues.


issues-v1

The Webhooks API allows you to subscribe to events happening in iTwin Platform.


Transformations

Samples