Transformations

Configurations

Download API definition:

POST https://sampleHostName/transformations/configurations/filterimodel

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. More information, samples and tutorials here.

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

Creating a configuration does not actually run the transformation. To run the transformation check out POST /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

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 wiki page.

Rate limits

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