Filter By Saved View - Transformations

Transformations

Download API definition:

This API is a Technical Preview and is available for testing purposes only. Do not use in production.

post https://qa-api.bentley.com/transformations/configurations/filter-by-saved-view

This endpoint is used to create a configuration for filtering geometric data in iModel based on a saved view stored in Saved View service.

Running transformation after saved view is updated, will update geometric data in target iModel. This means that filtered out geometric data will be removed and newly visible geometric data will be inserted.

Preferred view mode can be set with 'viewMode' transform parameter. If view mode is not specified, IncludeNewContent will be used by default.

This transformation is usually leveraged to filter out unnecessary data and align an iModel to the view within a browser window.

Limitations: Saved views are capable of displaying elements while hiding their parent elements. This cannot be achieved by filtering logic because child elements cannot exist without their parent elements within an iModel. To workaround this misalignment between display and filtering logic, the transformations service does not filter out:

elements that are ancestors of visible child elements
elements that are scoping ancestors of visible elements

Such elements will remain in iModel with cleared properties, meaning that their geometries and other non mandatory properties will be deleted.

In addition to exported data, the transformer will also push some additional metadata. This metadata contains:

BisCore:RepositoryLink and BisCore:ExternalSource elements that mark the source where the data was imported from.
A "Scope" BisCore:ExternalSourceAspect that contains Synchronization changeset metadata that is needed by the transformation service to process any later changes correctly.
Element provenance information (BisCore:ExternalSourceAspects) for elements that do not have federation guids.

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 itwin-platform.

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

Authorization

You must have imodels_write assigned for the target iModel and imodels_read assigned for the source iModel within related configuration. You can check iModel permissions here.

Rate limits

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

Request

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Request body

Create filter by saved view transformation

name

String

Yes

User friendly name of the transformation.

sourceIModelId

String

Yes

ID of the source iModel.

targetIModelId

String

Yes

ID of the target iModel.

transformParameters

TParams_FilterBySavedView_Create

Yes

changesetDescription

String

Yes

Description for the changeset created after transformation.

Example

json

{
    "name": "Example name",
    "sourceIModelId": "00000000-0000-0000-0000-000000000000",
    "targetIModelId": "00000000-0000-0000-0000-000000000000",
    "changesetDescription": "Example description",
    "transformParameters": {
        "savedViewId": "AAAaa0AAaa0AaAAAAaaAAAaAaA-AAA000AAaaa0_Aa0AOa0aaAA0A-a0a0AA-Aa0AAa",
        "viewMode": "IncludeNewContent"
    }
}

Response

Response 201 Created

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

json

{
    "configuration": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "Transformation name",
        "changesetDescription": "Example description",
        "createdDateTime": "2021-08-02T02:51:33.0000000+00:00",
        "modifiedDateTime": "2021-08-02T02:52:33.0000000+00:00",
        "transformType": "FilterBySavedView",
        "transformParameters": {
            "_links": {
                "savedView": {
                    "href": "https://api.bentley.com/savedViews/AAAaa0AAaa0AaAAAAaaAAAaAaA-AAA000AAaaa0_Aa0AOa0aaAA0A-a0a0AA-Aa0AAa"
                }
            },
            "viewMode": "IncludeNewContent"
        },
        "_links": {
            "sourceIModel": {
                "href": "https://api.bentley.com/imodels/00000000-0000-0000-0000-000000000000"
            },
            "targetIModel": {
                "href": "https://api.bentley.com/imodels/00000000-0000-0000-0000-000000000000"
            }
        }
    }
}

Response 400 Bad Request

The request cannot be processed by the server due to a client error (e.g. malformed request syntax)

json

{
    "error": {
        "code": "MissingRequestBody",
        "message": "Request body was not provided."
    }
}

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

{
    "error": {
        "code": "HeaderNotFound",
        "message": "Header Authorization was not found in the request. Access denied."
    }
}

Response 403 Forbidden

User is not authorized to create a configuration.

json

{
    "error": {
        "code": "InsufficientPermissions",
        "message": "The user has insufficient permissions for the requested operation."
    }
}

Response 422 Unprocessable Entity

The referenced iModel does not exist.

json

{
    "error": {
        "code": "InvalidTransformationsRequest",
        "message": "Cannot create Configuration.",
        "details": [{
            "code": "InvalidRequestBody",
            "message": "User is missing permission 'Read' to iModel '00000000-0000-0000-0000-000000000000'.",
            "target": "SourceIModelId"
        }]
    }
}

Response 429 Too many requests

This response indicates that the client sent more requests than allowed by this API for the current tier of the client.

json

{
    "error": {
        "code": "RateLimitExceeded",
        "message": "The client sent more requests than allowed by this API for the current tier of the client."
    }
}

Response headers

retry-after

Number of seconds to wait until client is allowed to make more requests.

Definitions

Link

href

String

Link to a resource.

json

{
    "type": "object",
    "title": "Link",
    "properties": {
        "href": {
            "type": "string",
            "description": "Link to a resource."
        }
    },
    "additionalProperties": false
}

Error

Contains error information.

code

String

One of a server-defined set of error codes.

target

String, null

The target of the error.

message

String

A human-readable representation of the error.

json

{
    "type": "object",
    "required": [
        "code",
        "message"
    ],
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "target": {
            "type": "string",
            "nullable": true,
            "description": "The target of the error."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        }
    },
    "description": "Contains error information.",
    "additionalProperties": true
}

View mode

Specifies saved view mode. 'FilterContent' filters out all new content that was introduced into the iModel after the view was created. 'IncludeNewContent' includes all new content that was introduced into the iModel after the view was created.

IncludeNewContent

String

FilterContent

String

json

{
    "enum": [
        "IncludeNewContent",
        "FilterContent"
    ],
    "type": "string",
    "title": "View mode",
    "description": "Specifies saved view mode. **'FilterContent'** filters out all new content that was introduced into the iModel after the view was created. **'IncludeNewContent'** includes all new content that was introduced into the iModel after the view was created. "
}

DetailedError

Contains error information and an array of more specific errors.

code

String

One of a server-defined set of error codes.

target

String, null

The target of the error.

details

Error[]

Optional array of more specific errors.

message

String

A human-readable representation of the error.

json

{
    "type": "object",
    "required": [
        "code",
        "message",
        "details"
    ],
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "target": {
            "type": "string",
            "nullable": true,
            "description": "The target of the error."
        },
        "details": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Error"
            },
            "description": "Optional array of more specific errors."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        }
    },
    "description": "Contains error information and an array of more specific errors.",
    "additionalProperties": true
}

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.

error

Error

Error information.

json

{
    "type": "object",
    "title": "Error Response",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "$ref": "#/components/schemas/Error",
            "description": "Error information."
        }
    },
    "description": "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.",
    "additionalProperties": false
}

Saved view link

savedView

Link

json

{
    "type": "object",
    "title": "Saved view link",
    "properties": {
        "savedView": {
            "$ref": "#/components/schemas/Link"
        }
    },
    "additionalProperties": false
}

Detailed Error Response

error

DetailedError

Error Detailed information.

json

{
    "type": "object",
    "title": "Detailed Error Response",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "$ref": "#/components/schemas/DetailedError",
            "description": "Error Detailed information."
        }
    },
    "description": "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.",
    "additionalProperties": false
}

Links

sourceIModel

Link

targetIModel

Link

json

{
    "type": "object",
    "title": "Links",
    "properties": {
        "sourceIModel": {
            "$ref": "#/components/schemas/Link"
        },
        "targetIModel": {
            "$ref": "#/components/schemas/Link"
        }
    },
    "additionalProperties": false
}

Filter by saved view configuration properties

_links

Links_SavedView

viewMode

ViewMode

json

{
    "type": "object",
    "title": "Filter by saved view configuration properties",
    "properties": {
        "_links": {
            "$ref": "#/components/schemas/Links_SavedView"
        },
        "viewMode": {
            "$ref": "#/components/schemas/ViewMode"
        }
    },
    "additionalProperties": false
}

Filter by saved view configuration properties transformType

Type of the transformation.

FilterBySavedView

String

json

{
    "enum": [
        "FilterBySavedView"
    ],
    "type": "string",
    "description": "Type of the transformation.",
    "title": "Filter by saved view configuration properties transformType"
}

Filter by saved view configuration properties

Configuration data.

String

ID of the configuration.

name

String

User friendly name of the transformation.

_links

Links_ConfigurationData

Filter by saved view configuration properties transformType

Configuration_FilterBySavedView-transformType

Type of the transformation.

createdDateTime

Date-time

Time the configuration was created at.

modifiedDateTime

Date-time

Time the configuration was last modified at.

transformParameters

TParams_FilterBySavedView

changesetDescription

String

Description for the changeset created after transformation.

json

{
    "type": "object",
    "title": "Filter by saved view configuration properties",
    "required": [
        "id",
        "name",
        "changesetDescription",
        "createdDateTime",
        "modifiedDateTime",
        "transformType",
        "_links"
    ],
    "properties": {
        "id": {
            "type": "string",
            "example": "00000000-0000-0000-0000-000000000000",
            "description": "ID of the configuration."
        },
        "name": {
            "type": "string",
            "example": "Example name",
            "description": "User friendly name of the transformation."
        },
        "_links": {
            "$ref": "#/components/schemas/Links_ConfigurationData"
        },
        "transformType": {
            "enum": [
                "FilterBySavedView"
            ],
            "type": "string",
            "description": "Type of the transformation.",
            "title": "Filter by saved view configuration properties transformType",
            "$ref": "#/components/schemas/Configuration_FilterBySavedView-transformType"
        },
        "createdDateTime": {
            "type": "string",
            "format": "date-time",
            "example": "0000-00-00T00:00:00.0000000Z",
            "description": "Time the configuration was created at."
        },
        "modifiedDateTime": {
            "type": "string",
            "format": "date-time",
            "example": "0000-00-00T00:00:00.0000000Z",
            "description": "Time the configuration was last modified at."
        },
        "transformParameters": {
            "$ref": "#/components/schemas/TParams_FilterBySavedView"
        },
        "changesetDescription": {
            "type": "string",
            "example": "Example comment",
            "description": "Description for the changeset created after transformation."
        }
    },
    "description": "Configuration data.",
    "additionalProperties": false
}

Filter by saved view properties

viewMode

ViewMode

savedViewId

String

Saved view id. Saved view must be marked as shared and must belong to source iModel.

json

{
    "type": "object",
    "title": "Filter by saved view properties",
    "required": [
        "savedViewId"
    ],
    "properties": {
        "viewMode": {
            "$ref": "#/components/schemas/ViewMode"
        },
        "savedViewId": {
            "type": "string",
            "description": "Saved view id. Saved view must be marked as shared and must belong to source iModel."
        }
    },
    "additionalProperties": false
}

Create filter by saved view transformation

Data needed to create a FilterBySavedView transformation configuration.

name

String

User friendly name of the transformation.

sourceIModelId

String

ID of the source iModel.

targetIModelId

String

ID of the target iModel.

transformParameters

TParams_FilterBySavedView_Create

changesetDescription

String

Description for the changeset created after transformation.

json

{
    "type": "object",
    "title": "Create filter by saved view transformation",
    "required": [
        "changesetDescription",
        "sourceIModelId",
        "targetIModelId",
        "name",
        "transformParameters"
    ],
    "properties": {
        "name": {
            "type": "string",
            "example": "Example name",
            "description": "User friendly name of the transformation."
        },
        "sourceIModelId": {
            "type": "string",
            "example": "00000000-0000-0000-0000-000000000000",
            "description": "ID of the source iModel."
        },
        "targetIModelId": {
            "type": "string",
            "example": "00000000-0000-0000-0000-000000000000",
            "description": "ID of the target iModel."
        },
        "transformParameters": {
            "$ref": "#/components/schemas/TParams_FilterBySavedView_Create"
        },
        "changesetDescription": {
            "type": "string",
            "example": "Example comment",
            "description": "Description for the changeset created after transformation."
        }
    },
    "description": "Data needed to create a FilterBySavedView transformation configuration.",
    "additionalProperties": false
}

Configuration filter by saved view

configuration

Configuration_FilterBySavedView

json

{
    "type": "object",
    "title": "Configuration filter by saved view",
    "properties": {
        "configuration": {
            "$ref": "#/components/schemas/Configuration_FilterBySavedView"
        }
    },
    "additionalProperties": false
}

Was this page helpful?