Download API definition:

POST https://sampleHostName/transformations/configurations/filterbyviewdefinition

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.

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
    - 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.
perModelCategoryVisibility - array of objects containing perModelCategoryVisibility data
    - modelId - id of model for which category override will apply.
    - categoryId - id of category for which the ovveride will apply.
    - visible - boolean flag indicating if category is visible for the given model.

All ids must be well-formed valid hexadecimal ids conforming with iTwin.js specification.

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.

Creating a configuration does not actually run the transformation. To run the transformation check out POST /transformations reference.


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.


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.