Get Configuration - Transformations

Transformations

Download API definition:

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

get https://qa-api.bentley.com/transformations/configurations/{configurationId}

This endpoint is used to query a configuration entity with a provided configurationId.

Note: the type of configuration in operation response is a union of different configuration types. Configuration type is denoted by transformType property. API consumers should expect that new configuration types will added in the future. New configurations may have a different schema than the ones that currently exist so configuration should be deserialized based on transformType.

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_read 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 parameters

configurationId

Yes

ID of the configuration

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Response

Response 200 OK

Returns a configuration for the given Id.

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:51: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 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 404 Not Found

Configuration with the given Id does not exist.

json

{
    "error": {
        "code": "ConfigurationNotFound",
        "message": "Requested Configuration is not available.",
        "target": "00000000-0000-0000-0000-000000000000"
    }
}

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. "
}

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
}

Link to a configuration

configuration

Link

json

{
    "type": "object",
    "title": "Link to a configuration",
    "properties": {
        "configuration": {
            "$ref": "#/components/schemas/Link"
        }
    },
    "additionalProperties": false
}

Configuration

configuration

One of: Configuration_FilterBySavedView Configuration_FilterIModel Configuration_ImportIModel Configuration_PopulateFederationGuids Configuration_MergeIModel Configuration_AlignIModelData Configuration_RemoveImportedData, null

Single configuration

json

{
    "type": "object",
    "title": "Configuration",
    "properties": {
        "configuration": {
            "oneOf": [
                {
                    "$ref": "#/components/schemas/Configuration_FilterBySavedView"
                },
                {
                    "$ref": "#/components/schemas/Configuration_FilterIModel"
                },
                {
                    "$ref": "#/components/schemas/Configuration_ImportIModel"
                },
                {
                    "$ref": "#/components/schemas/Configuration_PopulateFederationGuids"
                },
                {
                    "$ref": "#/components/schemas/Configuration_MergeIModel"
                },
                {
                    "$ref": "#/components/schemas/Configuration_AlignIModelData"
                },
                {
                    "$ref": "#/components/schemas/Configuration_RemoveImportedData"
                }
            ],
            "nullable": true,
            "description": "Single configuration"
        }
    },
    "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
}

ImportIModel configuration properties

fedGuidsOfRepositoriesToExport

String[]

json

{
    "type": "object",
    "title": "ImportIModel configuration properties",
    "properties": {
        "fedGuidsOfRepositoriesToExport": {
            "type": "array",
            "items": {
                "type": "string"
            },
            "maxItems": 1
        }
    },
    "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
}

Align iModel data configuration properties

dataRemappingOptions

TParams_AlignIModelData_DataRemappingOptions

schemaOptimizationOptions

TParams_AlignIModelData_SchemaOptimizationOptions

json

{
    "type": "object",
    "title": "Align iModel data configuration properties",
    "properties": {
        "dataRemappingOptions": {
            "$ref": "#/components/schemas/TParams_AlignIModelData_DataRemappingOptions"
        },
        "schemaOptimizationOptions": {
            "$ref": "#/components/schemas/TParams_AlignIModelData_SchemaOptimizationOptions"
        }
    },
    "additionalProperties": false
}

Merge iModel configuration properties transformType

Type of the transformation.

MergeIModel

String

json

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

Merge iModel configuration properties

String

ID of the configuration.

name

String

User friendly name of the transformation.

_links

Links_ConfigurationData

Merge iModel configuration properties transformType

Configuration_MergeIModel-transformType

Type of the transformation.

createdDateTime

Date-time

Time the configuration was created at.

modifiedDateTime

Date-time

Time the configuration was last modified at.

changesetDescription

String

Description for the changeset created after transformation.

json

{
    "type": "object",
    "title": "Merge iModel 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": [
                "MergeIModel"
            ],
            "type": "string",
            "description": "Type of the transformation.",
            "title": "Merge iModel configuration properties transformType",
            "$ref": "#/components/schemas/Configuration_MergeIModel-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."
        },
        "changesetDescription": {
            "type": "string",
            "example": "Example comment",
            "description": "Description for the changeset created after transformation."
        }
    },
    "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 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
}

Import iModel configuration properties transformType

Type of the transformation.

ImportIModel

String

json

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

Import iModel configuration properties

String

ID of the configuration.

name

String

User friendly name of the transformation.

_links

Links_ConfigurationData

Import iModel configuration properties transformType

Configuration_ImportIModel-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_ImportIModel

changesetDescription

String

Description for the changeset created after transformation.

json

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

Remove imported data configuration properties

_links

Links_Configuration

json

{
    "type": "object",
    "title": "Remove imported data configuration properties",
    "properties": {
        "_links": {
            "$ref": "#/components/schemas/Links_Configuration"
        }
    },
    "additionalProperties": false
}

Align iModel data configuration properties transformType

Type of the transformation.

AlignIModelData

String

json

{
    "enum": [
        "AlignIModelData"
    ],
    "type": "string",
    "description": "Type of the transformation.",
    "title": "Align iModel data configuration properties transformType"
}

Align iModel data configuration properties

Configuration data.

String

ID of the configuration.

name

String

User friendly name of the transformation.

_links

Links_ConfigurationData

Align iModel data configuration properties transformType

Configuration_AlignIModelData-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_AlignIModelData

changesetDescription

String

Description for the changeset created after transformation.

json

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

Remove imported data configuration properties transformType

Type of the transformation.

RemoveImportedData

String

json

{
    "enum": [
        "RemoveImportedData"
    ],
    "type": "string",
    "description": "Type of the transformation.",
    "title": "Remove imported data configuration properties transformType"
}

Remove imported data configuration properties

Configuration data.

String

ID of the configuration.

name

String

User friendly name of the transformation.

_links

Links_ConfigurationData

Remove imported data configuration properties transformType

Configuration_RemoveImportedData-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_RemoveImportedData

changesetDescription

String

Description for the changeset created after transformation.

json

{
    "type": "object",
    "title": "Remove imported data configuration properties",
    "required": [
        "id",
        "name",
        "changesetDescription",
        "createdDateTime",
        "modifiedDateTime",
        "transformType",
        "transformParameters",
        "_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": [
                "RemoveImportedData"
            ],
            "type": "string",
            "description": "Type of the transformation.",
            "title": "Remove imported data configuration properties transformType",
            "$ref": "#/components/schemas/Configuration_RemoveImportedData-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_RemoveImportedData"
        },
        "changesetDescription": {
            "type": "string",
            "example": "Example comment",
            "description": "Description for the changeset created after transformation."
        }
    },
    "description": "Configuration data.",
    "additionalProperties": false
}

EC class definition

ecClassName

String

EC Class name

ecSchemaName

String

EC Schema name

json

{
    "type": "object",
    "title": "EC class definition",
    "required": [
        "ecSchemaName",
        "ecClassName"
    ],
    "properties": {
        "ecClassName": {
            "type": "string",
            "example": "GraphicalElement3d",
            "description": "EC Class name"
        },
        "ecSchemaName": {
            "type": "string",
            "example": "BisCore",
            "description": "EC Schema name"
        }
    },
    "additionalProperties": false
}

EC schema definition

ecSchemaName

String

EC Schema name

ecSchemaVersion

String

EC Schema version

json

{
    "type": "object",
    "title": "EC schema definition",
    "required": [
        "ecSchemaName",
        "ecSchemaVersion"
    ],
    "properties": {
        "ecSchemaName": {
            "type": "string",
            "example": "BisCore",
            "description": "EC Schema name"
        },
        "ecSchemaVersion": {
            "type": "string",
            "example": "01.00.14",
            "description": "EC Schema version"
        }
    },
    "additionalProperties": false
}

Single iModel Configuration Links

iModel

Link

json

{
    "type": "object",
    "title": "Single iModel Configuration Links",
    "properties": {
        "iModel": {
            "$ref": "#/components/schemas/Link"
        }
    },
    "additionalProperties": false
}

Element group properties

targetECClass

TParams_Common_ECClassDefinition

elementPropertyQuery

String

ECSql query

json

{
    "type": "object",
    "title": "Element group properties",
    "required": [
        "elementPropertyQuery",
        "targetECClass"
    ],
    "properties": {
        "targetECClass": {
            "$ref": "#/components/schemas/TParams_Common_ECClassDefinition"
        },
        "elementPropertyQuery": {
            "type": "string",
            "example": "SELECT ECInstanceId FROM Generic.PhysicalObject",
            "description": "ECSql query"
        }
    },
    "additionalProperties": false
}

Populate Federation Guids configuration properties transformType

Type of the transformation.

PopulateFederationGuids

String

json

{
    "enum": [
        "PopulateFederationGuids"
    ],
    "type": "string",
    "description": "Type of the transformation.",
    "title": "Populate Federation Guids configuration properties transformType"
}

Populate Federation Guids configuration properties

String

ID of the configuration.

name

String

User friendly name of the transformation.

_links

Links_SingleIModelConfigurationData

Populate Federation Guids configuration properties transformType

Configuration_PopulateFederationGuids-transformType

Type of the transformation.

createdDateTime

Date-time

Time the configuration was created at.

modifiedDateTime

Date-time

Time the configuration was last modified at.

changesetDescription

String

Description for the changeset created after transformation.

json

{
    "type": "object",
    "title": "Populate Federation Guids 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_SingleIModelConfigurationData"
        },
        "transformType": {
            "enum": [
                "PopulateFederationGuids"
            ],
            "type": "string",
            "description": "Type of the transformation.",
            "title": "Populate Federation Guids configuration properties transformType",
            "$ref": "#/components/schemas/Configuration_PopulateFederationGuids-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."
        },
        "changesetDescription": {
            "type": "string",
            "example": "Example comment",
            "description": "Description for the changeset created after transformation."
        }
    },
    "additionalProperties": false
}

EC Class merging group

targetECClass

TParams_Common_ECClassDefinition

sourceECClasses

TParams_Common_ECClassDefinition[]

Array of EC classes that will be merged into the target class.

json

{
    "type": "object",
    "title": "EC Class merging group",
    "required": [
        "targetECClass",
        "sourceECClasses"
    ],
    "properties": {
        "targetECClass": {
            "$ref": "#/components/schemas/TParams_Common_ECClassDefinition"
        },
        "sourceECClasses": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/TParams_Common_ECClassDefinition"
            },
            "description": "Array of EC classes that will be merged into the target class."
        }
    },
    "additionalProperties": false
}

Data remapping options

elementGroups

TParams_AlignIModelData_ElementGroup[]

Array of element groups that are to be remapped.

additionalECSchemas

TParams_Common_ECSchemaDefinition[]

Array of EC schemas that will be added to target iModel after transformation.

json

{
    "type": "object",
    "title": "Data remapping options",
    "required": [
        "elementGroups"
    ],
    "properties": {
        "elementGroups": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/TParams_AlignIModelData_ElementGroup"
            },
            "description": "Array of element groups that are to be remapped."
        },
        "additionalECSchemas": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/TParams_Common_ECSchemaDefinition"
            },
            "description": "Array of EC schemas that will be added to target iModel after transformation."
        }
    },
    "additionalProperties": false
}

Schema optimization options

classMergingGroups

TParams_AlignIModelData_ClassMergingGroup[]

Array of EC class merging groups

removeUnusedClasses

Boolean

Option to remove unused EC classes from dynamic EC schemas.

json

{
    "type": "object",
    "title": "Schema optimization options",
    "properties": {
        "classMergingGroups": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/TParams_AlignIModelData_ClassMergingGroup"
            },
            "description": "Array of EC class merging groups"
        },
        "removeUnusedClasses": {
            "type": "boolean",
            "description": "Option to remove unused EC classes from dynamic EC schemas."
        }
    },
    "additionalProperties": false
}

Was this page helpful?