Delete Configuration - Transformations

Transformations

Download API definition:

delete https://dev-api.bentley.com/transformations/configurations/{configurationId}

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

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.

You must have imodels_write assigned at the target project level and imodels_read assigned at the source project level within related configuration. If permissions at the project level are not configured, then you must have same assigned at the iModel level.

Alternatively, you must 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 see 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.

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.v1+json is recommended.

Response

Response 200 OK

Deletes the configuration for the given ID and returns it.

json

{
    "configuration": {
        "id": "00000000-0000-0000-0000-000000000000",
        "transformName": "Transformation name",
        "comment": "comment",
        "createdDateTime": "2021-08-02T14:51:33.6133333+00:00",
        "modifiedDateTime": "2021-08-02T14:51:33.6133333+00:00",
        "transformType": "FilterByViewDefinition",
        "transformParameters": {
            "models": [2199023260161],
            "categories": [2199023260161],
            "neverDrawn": [2199023260161],
            "alwaysDrawn": [2199023260161],
            "isAlwaysDrawnExclusive": true,
            "subCategoryOvr": [{
                "invisible": true,
                "subCategory": 2199023260161
            }],
            "clip": {
                "shapes": [{
                    "points": [
                        [0, 1, 2],
                        [2, 3, 4],
                        [3, 4, 5],
                        [4, 5, 6]
                    ],
                    "trans": [
                        [5, 6, 7, 8],
                        [6, 7, 8, 9],
                        [7, 8, 9, 0]
                    ],
                    "zlow": 1,
                    "zhigh": 2,
                    "mask": true,
                    "invisible": false
                }],
                "planes": [{
                    "invisible": true,
                    "clips": [
                        [{
                            "normal": [0, 1, 2],
                            "dist": 9,
                            "invisible": false,
                            "interior": true
                        }]
                    ]
                }]
            },
            "perModelCategoryVisibility": [{
                "modelId": 2199023260162,
                "categoryId": 2199023260163,
                "visible": 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"
            },
            "sourceProject": {
                "href": "https://api.bentley.com/itwins/00000000-0000-0000-0000-000000000000"
            },
            "targetProject": {
                "href": "https://api.bentley.com/itwins/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 403 Forbidden

User has insufficient permissions.

json

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

Response 404 Not Found

Configuration with the given ID does not exist.

json

{
    "error": {
        "code": "ConfigurationNotFound",
        "message": "Requested Configuration is not available."
    }
}

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
}

Configuration

configuration

One of: Configuration_CombineIModels Configuration_CombinePhysicalModels Configuration_FilterBySavedView Configuration_FilterByViewDefinition Configuration_FilterIModel Configuration_FilterSubCategories Configuration_MergeFork Configuration_CombinePhysicalModelsV2 Configuration_CreateFork Configuration_ImportIModel Configuration_PopulateFederationGuids Configuration_MergeIModel, null

Single configuration

json

{
    "type": "object",
    "title": "Configuration",
    "properties": {
        "configuration": {
            "oneOf": [
                {
                    "$ref": "#/components/schemas/Configuration_CombineIModels"
                },
                {
                    "$ref": "#/components/schemas/Configuration_CombinePhysicalModels"
                },
                {
                    "$ref": "#/components/schemas/Configuration_FilterBySavedView"
                },
                {
                    "$ref": "#/components/schemas/Configuration_FilterByViewDefinition"
                },
                {
                    "$ref": "#/components/schemas/Configuration_FilterIModel"
                },
                {
                    "$ref": "#/components/schemas/Configuration_FilterSubCategories"
                },
                {
                    "$ref": "#/components/schemas/Configuration_MergeFork"
                },
                {
                    "$ref": "#/components/schemas/Configuration_CombinePhysicalModelsV2"
                },
                {
                    "$ref": "#/components/schemas/Configuration_CreateFork"
                },
                {
                    "$ref": "#/components/schemas/Configuration_ImportIModel"
                },
                {
                    "$ref": "#/components/schemas/Configuration_PopulateFederationGuids"
                },
                {
                    "$ref": "#/components/schemas/Configuration_MergeIModel"
                }
            ],
            "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
}

Combine iModels configuration properties

iModels

TParams_CombineIModels_IModel[]

json

{
    "type": "object",
    "title": "Combine iModels configuration properties",
    "required": [
        "iModels"
    ],
    "properties": {
        "iModels": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/TParams_CombineIModels_IModel"
            }
        }
    },
    "additionalProperties": false
}

Merge fork configuration properties

String

ID of the configuration.

_links

Links_ConfigurationData

comment

String, null

Comment for the changeset created after transformation.

transformName

String

User friendly name of the transformation.

transformType

String

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_MergeFork_Configuration

json

{
    "type": "object",
    "title": "Merge fork configuration properties",
    "required": [
        "id",
        "transformName",
        "comment",
        "createdDateTime",
        "modifiedDateTime",
        "transformParameters",
        "transformType",
        "_links"
    ],
    "properties": {
        "id": {
            "type": "string",
            "example": "00000000-0000-0000-0000-000000000000",
            "description": "ID of the configuration."
        },
        "_links": {
            "$ref": "#/components/schemas/Links_ConfigurationData"
        },
        "comment": {
            "type": "string",
            "example": "Example comment",
            "nullable": true,
            "description": "Comment for the changeset created after transformation."
        },
        "transformName": {
            "type": "string",
            "example": "Example name",
            "description": "User friendly name of the transformation."
        },
        "transformType": {
            "type": "string",
            "example": "FilterIModel",
            "description": "Type of the transformation."
        },
        "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_MergeFork_Configuration"
        }
    },
    "additionalProperties": false
}

Links

sourceIModel

targetIModel

sourceProject

targetProject

json

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

Create fork configuration properties

String

ID of the configuration.

_links

Links_ConfigurationData

comment

String, null

Comment for the changeset created after transformation.

transformName

String

User friendly name of the transformation.

transformType

String

Type of the transformation.

createdDateTime

Date-time

Time the configuration was created at.

modifiedDateTime

Date-time

Time the configuration was last modified at.

json

{
    "type": "object",
    "title": "Create fork configuration properties",
    "required": [
        "id",
        "transformName",
        "comment",
        "createdDateTime",
        "modifiedDateTime",
        "transformType",
        "_links"
    ],
    "properties": {
        "id": {
            "type": "string",
            "example": "00000000-0000-0000-0000-000000000000",
            "description": "ID of the configuration."
        },
        "_links": {
            "$ref": "#/components/schemas/Links_ConfigurationData"
        },
        "comment": {
            "type": "string",
            "example": "Example comment",
            "nullable": true,
            "description": "Comment for the changeset created after transformation."
        },
        "transformName": {
            "type": "string",
            "example": "Example name",
            "description": "User friendly name of the transformation."
        },
        "transformType": {
            "type": "string",
            "example": "FilterIModel",
            "description": "Type of the transformation."
        },
        "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."
        }
    },
    "additionalProperties": false
}

Merge iModel configuration properties

String

ID of the configuration.

_links

Links_ConfigurationData

comment

String, null

Comment for the changeset created after transformation.

transformName

String

User friendly name of the transformation.

transformType

String

Type of the transformation.

createdDateTime

Date-time

Time the configuration was created at.

modifiedDateTime

Date-time

Time the configuration was last modified at.

json

{
    "type": "object",
    "title": "Merge iModel configuration properties",
    "required": [
        "id",
        "transformName",
        "comment",
        "createdDateTime",
        "modifiedDateTime",
        "transformType",
        "_links"
    ],
    "properties": {
        "id": {
            "type": "string",
            "example": "00000000-0000-0000-0000-000000000000",
            "description": "ID of the configuration."
        },
        "_links": {
            "$ref": "#/components/schemas/Links_ConfigurationData"
        },
        "comment": {
            "type": "string",
            "example": "Example comment",
            "nullable": true,
            "description": "Comment for the changeset created after transformation."
        },
        "transformName": {
            "type": "string",
            "example": "Example name",
            "description": "User friendly name of the transformation."
        },
        "transformType": {
            "type": "string",
            "example": "FilterIModel",
            "description": "Type of the transformation."
        },
        "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."
        }
    },
    "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

Configuration data.

String

ID of the configuration.

_links

Links_ConfigurationData

comment

String

Comment for the changeset created after transformation.

transformName

String

User friendly name of the transformation.

transformType

String

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

json

{
    "type": "object",
    "title": "Filter iModel configuration",
    "properties": {
        "id": {
            "type": "string",
            "example": "00000000-0000-0000-0000-000000000000",
            "description": "ID of the configuration."
        },
        "_links": {
            "$ref": "#/components/schemas/Links_ConfigurationData"
        },
        "comment": {
            "type": "string",
            "example": "Example comment",
            "description": "Comment for the changeset created after transformation."
        },
        "transformName": {
            "type": "string",
            "example": "Example name",
            "description": "User friendly name of the transformation."
        },
        "transformType": {
            "type": "string",
            "example": "FilterIModel",
            "description": "Type of the transformation."
        },
        "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"
        }
    },
    "description": "Configuration data.",
    "additionalProperties": false
}

Import iModel configuration properties

String

ID of the configuration.

_links

Links_ConfigurationData

comment

String, null

Comment for the changeset created after transformation.

transformName

String

User friendly name of the transformation.

transformType

String

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

json

{
    "type": "object",
    "title": "Import iModel configuration properties",
    "required": [
        "id",
        "transformName",
        "comment",
        "createdDateTime",
        "modifiedDateTime",
        "transformType",
        "_links"
    ],
    "properties": {
        "id": {
            "type": "string",
            "example": "00000000-0000-0000-0000-000000000000",
            "description": "ID of the configuration."
        },
        "_links": {
            "$ref": "#/components/schemas/Links_ConfigurationData"
        },
        "comment": {
            "type": "string",
            "example": "Example comment",
            "nullable": true,
            "description": "Comment for the changeset created after transformation."
        },
        "transformName": {
            "type": "string",
            "example": "Example name",
            "description": "User friendly name of the transformation."
        },
        "transformType": {
            "type": "string",
            "example": "FilterIModel",
            "description": "Type of the transformation."
        },
        "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"
        }
    },
    "additionalProperties": false
}

Filter sub categories properties

subCategoryNames

String[]

json

{
    "type": "object",
    "title": "Filter sub categories properties",
    "properties": {
        "subCategoryNames": {
            "type": "array",
            "items": {
                "type": "string"
            }
        }
    },
    "additionalProperties": false
}

Combine iModels configuration

Configuration data.

String

ID of the configuration.

_links

Links_ConfigurationData

comment

String

Comment for the changeset created after transformation.

transformName

String

User friendly name of the transformation.

transformType

String

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_CombineIModels

json

{
    "type": "object",
    "title": "Combine iModels configuration",
    "properties": {
        "id": {
            "type": "string",
            "example": "00000000-0000-0000-0000-000000000000",
            "description": "ID of the configuration."
        },
        "_links": {
            "$ref": "#/components/schemas/Links_ConfigurationData"
        },
        "comment": {
            "type": "string",
            "example": "Example comment",
            "description": "Comment for the changeset created after transformation."
        },
        "transformName": {
            "type": "string",
            "example": "Example name",
            "description": "User friendly name of the transformation."
        },
        "transformType": {
            "type": "string",
            "example": "FilterIModel",
            "description": "Type of the transformation."
        },
        "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_CombineIModels"
        }
    },
    "description": "Configuration data.",
    "additionalProperties": false
}

TParams_CombineIModels_IModel

_links

TParams_CombineIModels_IModel_Links

json

{
    "type": "object",
    "required": [
        "_links"
    ],
    "properties": {
        "_links": {
            "$ref": "#/components/schemas/TParams_CombineIModels_IModel_Links"
        }
    },
    "additionalProperties": false
}

Combine Physical Models configuration properties

numberOfModels

Integer

simplifyGeometry

Boolean

json

{
    "type": "object",
    "title": "Combine Physical Models configuration properties",
    "properties": {
        "numberOfModels": {
            "type": "integer"
        },
        "simplifyGeometry": {
            "type": "boolean"
        }
    },
    "additionalProperties": false
}

Filter by view definition properties

clip

TParams_FilterByViewDefinition_ClipData

models

String[]

viewMode

ViewMode

Filter by saved view configuration properties

Configuration data.

String

ID of the configuration.

_links

Links_ConfigurationData

comment

String

Comment for the changeset created after transformation.

transformName

String

User friendly name of the transformation.

transformType

String

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

json

{
    "type": "object",
    "title": "Filter by saved view configuration properties",
    "properties": {
        "id": {
            "type": "string",
            "example": "00000000-0000-0000-0000-000000000000",
            "description": "ID of the configuration."
        },
        "_links": {
            "$ref": "#/components/schemas/Links_ConfigurationData"
        },
        "comment": {
            "type": "string",
            "example": "Example comment",
            "description": "Comment for the changeset created after transformation."
        },
        "transformName": {
            "type": "string",
            "example": "Example name",
            "description": "User friendly name of the transformation."
        },
        "transformType": {
            "type": "string",
            "example": "FilterBySavedView",
            "description": "Type of the transformation."
        },
        "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"
        }
    },
    "description": "Configuration data.",
    "additionalProperties": false
}

Combine physical models v2 configuration

modelGroups

TParams_CombinePhysicalModelsV2_GroupUnselectedModels[]

Array of model groups

simplifyGeometry

Boolean

optional parameter indicating if geometry simplification should be used (transforming parasolids to meshes). Default if not specified - false.

groupUnselectedModels

Boolean

Indicates if unselected models must be grouped

unselectedModelsGroupName

String

Name of unselected models group. Must be specified if groupUnselectedModels is set to true.

json

{
    "type": "object",
    "title": "Combine physical models v2 configuration",
    "required": [
        "modelGroups"
    ],
    "properties": {
        "modelGroups": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/TParams_CombinePhysicalModelsV2_GroupUnselectedModels"
            },
            "description": "Array of model groups"
        },
        "simplifyGeometry": {
            "type": "boolean",
            "description": "optional parameter indicating if geometry simplification should be used (transforming parasolids to meshes). Default if not specified - false."
        },
        "groupUnselectedModels": {
            "type": "boolean",
            "description": "Indicates if unselected models must be grouped"
        },
        "unselectedModelsGroupName": {
            "type": "string",
            "description": "Name of unselected models group. Must be specified if groupUnselectedModels is set to true."
        }
    },
    "additionalProperties": false
}

Merge fork configuration transform parameters

_links

TParams_MergeFork_Configuration_Links

json

{
    "type": "object",
    "title": "Merge fork configuration transform parameters",
    "required": [
        "_links"
    ],
    "properties": {
        "_links": {
            "$ref": "#/components/schemas/TParams_MergeFork_Configuration_Links"
        }
    },
    "additionalProperties": false
}

Filter sub categories configuration properties

Configuration data.

String

ID of the configuration.

_links

Links_ConfigurationData

comment

String

Comment for the changeset created after transformation.

transformName

String

User friendly name of the transformation.

transformType

String

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_FilterSubCategories

json

{
    "type": "object",
    "title": "Filter sub categories configuration properties",
    "properties": {
        "id": {
            "type": "string",
            "example": "00000000-0000-0000-0000-000000000000",
            "description": "ID of the configuration."
        },
        "_links": {
            "$ref": "#/components/schemas/Links_ConfigurationData"
        },
        "comment": {
            "type": "string",
            "example": "Example comment",
            "description": "Comment for the changeset created after transformation."
        },
        "transformName": {
            "type": "string",
            "example": "Example name",
            "description": "User friendly name of the transformation."
        },
        "transformType": {
            "type": "string",
            "example": "FilterIModel",
            "description": "Type of the transformation."
        },
        "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_FilterSubCategories"
        }
    },
    "description": "Configuration data.",
    "additionalProperties": false
}

Combine Physical Models configuration

Configuration data.

String

ID of the configuration.

_links

Links_ConfigurationData

comment

String

Comment for the changeset created after transformation.

transformName

String

User friendly name of the transformation.

transformType

String

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_CombinePhysicalModels

json

{
    "type": "object",
    "title": "Combine Physical Models configuration",
    "properties": {
        "id": {
            "type": "string",
            "example": "00000000-0000-0000-0000-000000000000",
            "description": "ID of the configuration."
        },
        "_links": {
            "$ref": "#/components/schemas/Links_ConfigurationData"
        },
        "comment": {
            "type": "string",
            "example": "Example comment",
            "description": "Comment for the changeset created after transformation."
        },
        "transformName": {
            "type": "string",
            "example": "Example name",
            "description": "User friendly name of the transformation."
        },
        "transformType": {
            "type": "string",
            "example": "FilterIModel",
            "description": "Type of the transformation."
        },
        "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_CombinePhysicalModels"
        }
    },
    "description": "Configuration data.",
    "additionalProperties": false
}

Single iModel Configuration Links

iModel

Link

project

Link

json

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

TParams_CombineIModels_IModel_Links

iModel

Link

project

Link

json

{
    "type": "object",
    "required": [
        "project",
        "iModel"
    ],
    "properties": {
        "iModel": {
            "$ref": "#/components/schemas/Link"
        },
        "project": {
            "$ref": "#/components/schemas/Link"
        }
    },
    "additionalProperties": false
}

Filter by view definition configuration properties

Configuration data.

String

ID of the configuration.

_links

Links_ConfigurationData

comment

String

Comment for the changeset created after transformation.

transformName

String

User friendly name of the transformation.

transformType

String

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_FilterByViewDefinition

json

{
    "type": "object",
    "title": "Filter by view definition configuration properties",
    "properties": {
        "id": {
            "type": "string",
            "example": "00000000-0000-0000-0000-000000000000",
            "description": "ID of the configuration."
        },
        "_links": {
            "$ref": "#/components/schemas/Links_ConfigurationData"
        },
        "comment": {
            "type": "string",
            "example": "Example comment",
            "description": "Comment for the changeset created after transformation."
        },
        "transformName": {
            "type": "string",
            "example": "Example name",
            "description": "User friendly name of the transformation."
        },
        "transformType": {
            "type": "string",
            "example": "FilterIModel",
            "description": "Type of the transformation."
        },
        "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_FilterByViewDefinition"
        }
    },
    "description": "Configuration data.",
    "additionalProperties": false
}

Combine physical models v2 configuration properties

String

ID of the configuration.

_links

Links_ConfigurationData

comment

String, null

Comment for the changeset created after transformation.

transformName

String

User friendly name of the transformation.

transformType

String

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_CombinePhysicalModelsV2

json

{
    "type": "object",
    "title": "Combine physical models v2 configuration properties",
    "required": [
        "id",
        "transformName",
        "comment",
        "createdDateTime",
        "modifiedDateTime",
        "transformParameters",
        "transformType",
        "_links"
    ],
    "properties": {
        "id": {
            "type": "string",
            "example": "00000000-0000-0000-0000-000000000000",
            "description": "ID of the configuration."
        },
        "_links": {
            "$ref": "#/components/schemas/Links_ConfigurationData"
        },
        "comment": {
            "type": "string",
            "example": "Example comment",
            "nullable": true,
            "description": "Comment for the changeset created after transformation."
        },
        "transformName": {
            "type": "string",
            "example": "Example name",
            "description": "User friendly name of the transformation."
        },
        "transformType": {
            "type": "string",
            "example": "FilterIModel",
            "description": "Type of the transformation."
        },
        "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_CombinePhysicalModelsV2"
        }
    },
    "additionalProperties": false
}

Populate Federation Guids configuration properties

String

ID of the configuration.

_links

Links_SingleIModelConfigurationData

comment

String, null

Comment for the changeset created after transformation.

transformName

String

User friendly name of the transformation.

transformType

String

Type of the transformation.

createdDateTime

Date-time

Time the configuration was created at.

modifiedDateTime

Date-time

Time the configuration was last modified at.

json

{
    "type": "object",
    "title": "Populate Federation Guids configuration properties",
    "required": [
        "id",
        "transformName",
        "comment",
        "createdDateTime",
        "modifiedDateTime",
        "transformType",
        "_links"
    ],
    "properties": {
        "id": {
            "type": "string",
            "example": "00000000-0000-0000-0000-000000000000",
            "description": "ID of the configuration."
        },
        "_links": {
            "$ref": "#/components/schemas/Links_SingleIModelConfigurationData"
        },
        "comment": {
            "type": "string",
            "example": "Example comment",
            "nullable": true,
            "description": "Comment for the changeset created after transformation."
        },
        "transformName": {
            "type": "string",
            "example": "Example name",
            "description": "User friendly name of the transformation."
        },
        "transformType": {
            "type": "string",
            "example": "PopulateFederationGuids",
            "description": "Type of the transformation."
        },
        "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."
        }
    },
    "additionalProperties": false
}

Merge fork configuration transform parameters links

configuration

Link

json

{
    "type": "object",
    "title": "Merge fork configuration transform parameters links",
    "required": [
        "configuration"
    ],
    "properties": {
        "configuration": {
            "$ref": "#/components/schemas/Link"
        }
    },
    "additionalProperties": false
}

TParams_FilterByViewDefinition_ClipData

planes

TParams_FilterByViewDefinition_ClipData_PlaneData[]

shapes

TParams_FilterByViewDefinition_ClipData_ShapeData[]

json

{
    "type": "object",
    "properties": {
        "planes": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/TParams_FilterByViewDefinition_ClipData_PlaneData"
            }
        },
        "shapes": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/TParams_FilterByViewDefinition_ClipData_ShapeData"
            }
        }
    },
    "additionalProperties": false
}

Filter by view definition sub category override properties

invisible

Boolean

subCategory

String

json

{
    "type": "object",
    "title": "Filter by view definition sub category override properties",
    "required": [
        "subCategory"
    ],
    "properties": {
        "invisible": {
            "type": "boolean"
        },
        "subCategory": {
            "type": "string"
        }
    },
    "additionalProperties": false
}

TParams_FilterByViewDefinition_ClipData_PlaneData

clips

Array[]

invisible

Boolean

json

{
    "type": "object",
    "properties": {
        "clips": {
            "type": "array",
            "items": {
                "type": "array",
                "items": {
                    "$ref": "#/components/schemas/TParams_FilterByViewDefinition_ClipData_PlaneData_PlaneClip"
                }
            }
        },
        "invisible": {
            "type": "boolean"
        }
    },
    "additionalProperties": false
}

TParams_FilterByViewDefinition_ClipData_ShapeData

mask

Boolean

zlow

Integer

trans

Array[]

zhigh

Integer

points

Array[]

invisible

Boolean

json

{
    "type": "object",
    "properties": {
        "mask": {
            "type": "boolean"
        },
        "zlow": {
            "type": "integer"
        },
        "trans": {
            "type": "array",
            "items": {
                "type": "array",
                "items": {
                    "type": "integer"
                }
            }
        },
        "zhigh": {
            "type": "integer"
        },
        "points": {
            "type": "array",
            "items": {
                "type": "array",
                "items": {
                    "type": "integer"
                }
            }
        },
        "invisible": {
            "type": "boolean"
        }
    },
    "additionalProperties": false
}

Group unselected models properties

targetModelName

String

Name for grouped models

sourceModelQuery

String

Query for grouping models

json

{
    "type": "object",
    "title": "Group unselected models properties",
    "properties": {
        "targetModelName": {
            "type": "string",
            "description": "Name for grouped models"
        },
        "sourceModelQuery": {
            "type": "string",
            "description": "Query for grouping models"
        }
    },
    "additionalProperties": false
}

Filter by view definition per model category visibility properties

modelId

String

visible

Boolean

categoryId

String

json

{
    "type": "object",
    "title": "Filter by view definition per model category visibility properties",
    "required": [
        "modelId",
        "categoryId",
        "visible"
    ],
    "properties": {
        "modelId": {
            "type": "string"
        },
        "visible": {
            "type": "boolean"
        },
        "categoryId": {
            "type": "string"
        }
    },
    "additionalProperties": false
}

Was this page helpful?