Get Configuration - Transformations

REST API Overview

Reference

Transformations

Download API definition:

GET https://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 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

Returns configuration for the given ID.

json

{
    "configuration": {
        "id": "00000000-0000-0000-0000-000000000000",
        "transformName": "Transformation name",
        "comment": "comment",
        "createdDateTime": "2021-08-02T14:51:33.6133333Z",
        "modifiedDateTime": "2021-08-02T14:51:33.6133333Z",
        "transformType": "FilterByViewDefinition",
        "transformParameters": {
            "models": ["0x20000001201"],
            "categories": ["0x20000001201"],
            "neverDrawn": ["0x20000001201"],
            "alwaysDrawn": ["0x20000001201"],
            "isAlwaysDrawnExclusive": true,
            "subCategoryOvr": [{
                "invisible": true,
                "subCategory": "0x20000001201"
            }],
            "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": "0x20000001202",
                "categoryId": "0x20000001203",
                "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 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 user has sent too many requests in a given amount of time.

json

{
    "error": {
        "code": "TooManyRequests",
        "message": "More requests were received than the subscription rate-limit allows."
    }
}

Response headers

retry-after

The number of requests exceeds the rate-limit for the client subscription.

Definitions

View mode

IncludeNewContent

String

FilterContent

String

Combine Physical Models configuration

Configuration data.

String

ID of the configuration.

transformName

String

User friendly name of the transformation.

comment

String

Comment for the changeset created after transformation.

createdDateTime

Date-time

Time the configuration was created at.

modifiedDateTime

Date-time

Time the configuration was last modified at.

transformType

String

Type of the transformation.

transformParameters

TParams_CombinePhysicalModels

Combine physical models configuration transform parameters.

_links

Links_ConfigurationData

Filter by view definition configuration properties

Configuration data.

String

ID of the configuration.

transformName

String

User friendly name of the transformation.

comment

String

Comment for the changeset created after transformation.

createdDateTime

Date-time

Time the configuration was created at.

modifiedDateTime

Date-time

Time the configuration was last modified at.

transformType

String

Type of the transformation.

transformParameters

TParams_FilterByViewDefinition

Filter by view definition configuration transform parameters.

_links

Links_ConfigurationData

Filter sub categories configuration properties

Configuration data.

String

ID of the configuration.

transformName

String

User friendly name of the transformation.

comment

String

Comment for the changeset created after transformation.

createdDateTime

Date-time

Time the configuration was created at.

modifiedDateTime

Date-time

Time the configuration was last modified at.

transformType

String

Type of the transformation.

transformParameters

TParams_FilterSubCategories

Filter sub categories configuration transform parameters.

_links

Links_ConfigurationData

Combine Physical Models configuration properties

numberOfModels

Integer

simplifyGeometry

Boolean

Filter sub categories properties

subCategoryNames

String[]

TParams_FilterByViewDefinition_ClipData

shapes

TParams_FilterByViewDefinition_ClipData_ShapeData[]

planes

TParams_FilterByViewDefinition_ClipData_PlaneData[]

Filter by view definition properties

models

String[]

hiddenModels

String[]

Filter by view definition per model category visibility properties

modelId

String

categoryId

String

visible

Boolean

Filter by view definition sub category override properties

invisible

Boolean

subCategory

String

TParams_FilterByViewDefinition_ClipData_ShapeData

points

Array[]

trans

Array[]

zlow

Integer

zhigh

Integer

mask

Boolean

invisible

Boolean

TParams_FilterByViewDefinition_ClipData_PlaneData

invisible

Boolean

clips

Array[]

Filter iModel configuration

Configuration data.

String

ID of the configuration.

transformName

String

User friendly name of the transformation.

comment

String

Comment for the changeset created after transformation.

createdDateTime

Date-time

Time the configuration was created at.

modifiedDateTime

Date-time

Time the configuration was last modified at.

transformType

String

Type of the transformation.

transformParameters

TParams_FilterIModel

Filter iModel configuration transform parameters.

_links

Links_ConfigurationData

Filter iModel configuration properties

ecSql

String

inclusive

Boolean

Combine iModels configuration properties

iModels

TParams_CombineIModels_IModel[]

Combine iModels configuration

Configuration data.

String

ID of the configuration.

transformName

String

User friendly name of the transformation.

comment

String

Comment for the changeset created after transformation.

createdDateTime

Date-time

Time the configuration was created at.

modifiedDateTime

Date-time

Time the configuration was last modified at.

transformType

String

Type of the transformation.

transformParameters

TParams_CombineIModels

Group and map configuration transform parameters.

_links

Links_ConfigurationData

TParams_CombineIModels_IModel_Links

iModel

Link

project

Link

TParams_CombineIModels_IModel

_links

TParams_CombineIModels_IModel_Links

Group and map configuration properties

Configuration data.

String

ID of the configuration.

transformName

String

User friendly name of the transformation.

comment

String, null

Comment for the changeset created after transformation.

createdDateTime

Date-time

Time the configuration was created at.

modifiedDateTime

Date-time

Time the configuration was last modified at.

transformType

String

Type of the transformation.

transformParameters

TParams_GroupAndMap_Returned

Group and map configuration transform parameters.

_links

Links_ConfigurationData

Links to a configuration data.

Group and map created configuration transformation parameters

_links

TParams_GroupAndMap_Mapping

Link to a mapping.

groupOverrides

TParams_GroupAndMap_GroupOverride_Returned[]

Array of a group override object.

additionalEcSchemas

TParams_Common_ECSchemaDefinition[]

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

Link to a mapping

mapping

Link

Link to a mapping.

Link to a group

group

Link

Link to a group.

Combine physical models v2 configuration

modelGroups

TParams_CombinePhysicalModelsV2_GroupUnselectedModels[]

Array of model groups

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.

simplifyGeometry

Boolean

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

Group unselected models properties

targetModelName

String

Name for grouped models

sourceModelQuery

String

Query for grouping models

Combine physical models v2 configuration properties

String

ID of the configuration.

transformName

String

User friendly name of the transformation.

comment

String, null

Comment for the changeset created after transformation.

createdDateTime

Date-time

Time the configuration was created at.

modifiedDateTime

Date-time

Time the configuration was last modified at.

transformType

String

Type of the transformation.

transformParameters

TParams_CombinePhysicalModelsV2

Combine physical models v2 configuration transform parameters.

_links

Links_ConfigurationData

Links to a configuration data.

Create fork configuration properties

String

ID of the configuration.

transformName

String

User friendly name of the transformation.

comment

String, null

Comment for the changeset created after transformation.

createdDateTime

Date-time

Time the configuration was created at.

modifiedDateTime

Date-time

Time the configuration was last modified at.

transformType

String

Type of the transformation.

_links

Links_ConfigurationData

Links to a configuration data.

Import iModel configuration properties

String

ID of the configuration.

transformName

String

User friendly name of the transformation.

comment

String, null

Comment for the changeset created after transformation.

createdDateTime

Date-time

Time the configuration was created at.

modifiedDateTime

Date-time

Time the configuration was last modified at.

transformType

String

Type of the transformation.

_links

Links_ConfigurationData

Links to a configuration data.

Merge iModel configuration properties

String

ID of the configuration.

transformName

String

User friendly name of the transformation.

comment

String, null

Comment for the changeset created after transformation.

createdDateTime

Date-time

Time the configuration was created at.

modifiedDateTime

Date-time

Time the configuration was last modified at.

transformType

String

Type of the transformation.

_links

Links_ConfigurationData

Links to a configuration data.

Populate Federation Guids configuration properties

String

ID of the configuration.

transformName

String

User friendly name of the transformation.

comment

String, null

Comment for the changeset created after transformation.

createdDateTime

Date-time

Time the configuration was created at.

modifiedDateTime

Date-time

Time the configuration was last modified at.

transformType

String

Type of the transformation.

_links

Links_SingleIModelConfigurationData

Links to a configuration data.

Merge fork configuration transform parameters links

configuration

Link

Merge fork configuration transform parameters

_links

TParams_MergeFork_Configuration_Links

Merge fork configuration properties

String

ID of the configuration.

transformName

String

User friendly name of the transformation.

comment

String, null

Comment for the changeset created after transformation.

createdDateTime

Date-time

Time the configuration was created at.

modifiedDateTime

Date-time

Time the configuration was last modified at.

transformType

String

Type of the transformation.

transformParameters

TParams_MergeFork_Configuration

Merge fork configuration transform parameters.

_links

Links_ConfigurationData

Links to a configuration data.

Configuration

configuration

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

Single configuration

Links

sourceIModel

Link

Link to a source iModel.

targetIModel

Link

Link to a target iModel.

sourceProject

Link

Link to a source project.

targetProject

Link

Link to a target project.

Single iModel Configuration Links

iModel

Link

Link to an iModel.

project

Link

Link to a project.

Link

href

String

Link to a resource.

EC class definition

ecSchemaName

String

EC Schema name

ecClassName

String

EC Class name

EC schema definition

ecSchemaName

String

EC Schema name

ecSchemaVersion

String

EC Schema version

Returned group override properties

_links

TParams_GroupAndMap_Group

Link to a group.

baseClass

TParams_Common_ECClassDefinition

Base class object.

Error

Contains error information.

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String, null

The target of the error.

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.