Filter IModel - 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-imodel

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.

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. Parent elements and parent models of selected elements are not filtered out. By default it is 'false'.
includeChildren - this property is only applicable when 'inclusive' property is set to 'true'. If this property is set to 'true', all child elements and child models of selected elements will be included into the selection. By default it is 'false'.

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 headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Create configuration (Filter iModel)

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_FilterIModel

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": {
        "ecSql": "string",
        "inclusive": true,
        "includeChildren": true
    }
}

Response 201 Created

Returns the created configuration for filtering iModel by ECSql query.

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": "FilterIModel",
        "transformParameters": {
            "ecSql": "test ECSql query",
            "inclusive": true,
            "includeChildren": true
        },
        "_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

If the given data is invalid.

json

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

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 has insufficient permissions.

json

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

Response 422 Unprocessable Entity

This response indicates that the provided iModel could not be found.

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
}

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
}

Filter iModel configuration properties

ecSql

String

inclusive

Boolean

includeChildren

Boolean

json

{
    "type": "object",
    "title": "Filter iModel configuration properties",
    "required": [
        "ecSql"
    ],
    "properties": {
        "ecSql": {
            "type": "string"
        },
        "inclusive": {
            "type": "boolean"
        },
        "includeChildren": {
            "type": "boolean"
        }
    },
    "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 iModel configuration transformType

Type of the transformation.

FilterIModel

String

json

{
    "enum": [
        "FilterIModel"
    ],
    "type": "string",
    "description": "Type of the transformation.",
    "title": "Filter iModel configuration transformType"
}

Filter iModel configuration

Configuration data.

String

ID of the configuration.

name

String

User friendly name of the transformation.

_links

Links_ConfigurationData

Filter iModel configuration transformType

Configuration_FilterIModel-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_FilterIModel

changesetDescription

String

Description for the changeset created after transformation.

json

{
    "type": "object",
    "title": "Filter iModel configuration",
    "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": [
                "FilterIModel"
            ],
            "type": "string",
            "description": "Type of the transformation.",
            "title": "Filter iModel configuration transformType",
            "$ref": "#/components/schemas/Configuration_FilterIModel-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_FilterIModel"
        },
        "changesetDescription": {
            "type": "string",
            "example": "Example comment",
            "description": "Description for the changeset created after transformation."
        }
    },
    "description": "Configuration data.",
    "additionalProperties": false
}

Create configuration (Filter iModel)

Data needed to create a 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_FilterIModel

changesetDescription

String

Description for the changeset created after transformation.

json

{
    "type": "object",
    "title": "Create configuration (Filter iModel)",
    "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_FilterIModel"
        },
        "changesetDescription": {
            "type": "string",
            "example": "Example comment",
            "description": "Description for the changeset created after transformation."
        }
    },
    "description": "Data needed to create a configuration.",
    "additionalProperties": false
}

Filter iModel configuration

configuration

Configuration_FilterIModel

json

{
    "type": "object",
    "title": "Filter iModel configuration",
    "properties": {
        "configuration": {
            "$ref": "#/components/schemas/Configuration_FilterIModel"
        }
    },
    "additionalProperties": false
}

Was this page helpful?