Create Connection Configurations - Synchronization

Synchronization

Download API definition:

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

POST https://api.bentley.com/synchronization/configurations/connections/{connectionid}

Create a configuration that defines how data is processed and synced to iModels with the specific connection.

Configurations

reclassifyDgnElements

Enables connector to change the base class of an element if its current classification comes from the Generic schema. The default value is false.

If this configuration is set to true:

Every Generic element in the model will be re-processed, so expect a longer synchronization job.
Elements that are derived from a BIS class will not be processed.
Elements that did not change in the source file may appear modified in iModel if you use the Changed Elements API.
Elements that changed will appear deleted and added in iModel if you use the Changed Elements API.
Suggest setting this configuration with caution and per required run basis, not perpetual.

Use case example: If you have been advised by Bentley support that the Connector has added additional support for your files' disciplines (e.g. additional BIS schema alignment), then this option should be enabled on the next run to opt-in to the updated alignment.

ignoreDgnAttachments

Enables skipping of all reference attachments. As a result, only the master file is synchronized into the iModel. Only applicable for .dgn and .dwg files. The default value is false.

A reference file could have a transform/ level override/ symbology override when attached through a master file. None of these settings will be available if the files are processed individually and could result in data not matching the intended design.

enableSheetsAndDrawings

Controls sheets and drawings synchronization. If enabled all sheet models and relayed drawings will be synchronized to an iModel. The default value is false.

enableC3dGraphsIn2dModel

Enables the separation of 2D elements from 3D elements in the target iModel when using Civil Connector. The 2D elements will be inserted into a graph model, while the 3D elements will be kept in the spatial model. The default value is false.

Standard AutoCAD 2D entities, such as MTEXT, LINE, POLYLINE, etc., laid on the XY plane in the model space, will be converted as 2D elements and inserted into the graph model. This feature flag does not impact alignments and their labels, which always stay in the spatial model.

If the file contains only AutoCAD entities and no Civil3D entities or has Civil3D model entities but no 2D graphics, we suggest leaving this configuration as false.

enableSheetIndex

A sheet index is a centralized and structured collection of sheets in your WorkSet. Enabling this flag triggers processing of sheet index files from the associated workspace.The default value is false.

Use case example: Sheet index can be useful in creating a construction document set. So a civil user might be interested in turning on this flag to get the content of the sheets he has configured.

filterBySheetIndex

A sheet index is a centralized and structured collection of sheets in your WorkSet. Enabling this flag limits (filters) the processing of sheets provided to the connector to the ones specified in the sheet index. The default value is false.

Use case example: Sheet index can be useful in creating a construction document set. However, there could be large number of sheets present in the input set and the user may be only interested in the ones specified by the sheet index. Enabling this flag allows such filtering.

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.

Request

Request parameters

connectionid

Yes

connection Id

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Request body

Connection configuration

reclassifyDgnElements

Boolean

Enables connector to change the base class of an element if its current classification comes from the Generic schema. The default value is false.

ignoreDgnAttachments

Boolean

Enables skipping of all reference attachments. As a result, only the master file is synchronized into the iModel. Only applicable for .dgn and .dwg files. The default value is false.

enableSheetsAndDrawings

Boolean

Controls sheets and drawings synchronization. The default value is false.

enableC3dGraphsIn2dModel

Boolean

Separates Civil3d Connector 2D elements from 3D elements in the target iModel. The 2D elements will be inserted into a graph model while the 3D elements will be kept in the spatial model. The default value is false.

enableSheetIndex

Boolean

Enables processing of sheet index files from the associated workspace.

filterBySheetIndex

Boolean

Enables a limit for the processing of sheets provided to the connector to the ones specified in the sheet index.

Example

json

{
    "reclassifyDgnElements": false,
    "ignoreDgnAttachments": true,
    "enableSheetsAndDrawings": false,
    "enableC3dGraphsIn2dModel": false,
    "filterBySheetIndex": false,
    "enableSheetIndex": false
}

Response

Response 201 Created

Connection successfully created.

json

{
    "configuration": {
        "scopeId": "lggkjEZmT0-NOd2XwpnXYdk9YzROk-1Jr77FJx5z754",
        "settings": {
            "reclassifyDgnElements": false,
            "ignoreDgnAttachments": true,
            "enableSheetsAndDrawings": false,
            "enableC3dGraphsIn2dModel": false,
            "enableSheetIndex": true,
            "filterBySheetIndex": true
        },
        "resolvedSettings": {
            "uploadDgnRealityData": true,
            "convertDgnTerrainModels": false,
            "enableSheetsAndDrawings": false,
            "squashIntermediateRevisions": false,
            "skipRvtReprojection": false,
            "convertDgnHyperModelingSections": true,
            "clampZExtent": false,
            "overrideRvtReprojectionDistance": 0,
            "enableSheetIndex": true,
            "filterBySheetIndex": true,
            "reclassifyDgnElements": false,
            "ignoreDgnAttachments": true,
            "enableC3dGraphsIn2dModel": false
        }
    }
}

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 409 Conflict

A configuration already exists.

json

{
    "error": {
        "code": "ConfigurationAlreadyExists",
        "message": "A configuration already exists for the specified connectionid."
    }
}

Response 422 Unprocessable Entity

Invalid request to create a configuration. Request payload might be missing some of the required properties.

json

{
    "error": {
        "code": "InvalidConfigurationRequest",
        "message": "Cannot perform operation.",
        "details": [{
                "code": "InvalidRequestBody",
                "message": "Error parsing JSON, malformed JSON."
            },
            {
                "code": "InvalidValue",
                "message": "Provided connectionid value is not valid.",
                "target": "connectionid"
            }
        ]
    }
}

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

Configuration response

configuration

Configuration entity

json

{
    "title": "Configuration response",
    "type": "object",
    "properties": {
        "configuration": {
            "$ref": "#/components/schemas/configuration",
            "description": "Configuration entity"
        }
    },
    "additionalProperties": false
}

Configuration

scopeId

String

Scope Id

settings

user-defined-connector-settings

Configuration settings

resolvedSettings

user-defined-connector-settings

Configuration resolved settings

json

{
    "title": "Configuration",
    "type": "object",
    "properties": {
        "scopeId": {
            "type": "string",
            "description": "Scope Id"
        },
        "settings": {
            "$ref": "#/components/schemas/user-defined-connector-settings",
            "description": "Configuration settings"
        },
        "resolvedSettings": {
            "$ref": "#/components/schemas/user-defined-connector-settings",
            "description": "Configuration resolved settings"
        }
    },
    "additionalProperties": false
}

Connection configuration

reclassifyDgnElements

Boolean

Enables connector to change the base class of an element if its current classification comes from the Generic schema. The default value is false.

ignoreDgnAttachments

Boolean

Enables skipping of all reference attachments. As a result, only the master file is synchronized into the iModel. Only applicable for .dgn and .dwg files. The default value is false.

enableSheetsAndDrawings

Boolean

Controls sheets and drawings synchronization. The default value is false.

enableC3dGraphsIn2dModel

Boolean

enableSheetIndex

Boolean

Enables processing of sheet index files from the associated workspace.

filterBySheetIndex

Boolean

Enables a limit for the processing of sheets provided to the connector to the ones specified in the sheet index.

json

{
    "title": "Connection configuration",
    "type": "object",
    "properties": {
        "reclassifyDgnElements": {
            "type": "boolean",
            "description": "Enables connector to change the base class of an element if its current classification comes from the Generic schema. The default value is false."
        },
        "ignoreDgnAttachments": {
            "type": "boolean",
            "description": "Enables skipping of all reference attachments. As a result, only the master file is synchronized into the iModel. Only applicable for .dgn and .dwg files. The default value is false."
        },
        "enableSheetsAndDrawings": {
            "type": "boolean",
            "description": "Controls sheets and drawings synchronization. The default value is false."
        },
        "enableC3dGraphsIn2dModel": {
            "type": "boolean",
            "description": "Separates Civil3d Connector 2D elements from 3D elements in the target iModel. The 2D elements will be inserted into a graph model while the 3D elements will be kept in the spatial model. The default value is false."
        },
        "enableSheetIndex": {
            "type": "boolean",
            "description": "Enables processing of sheet index files from the associated workspace."
        },
        "filterBySheetIndex": {
            "type": "boolean",
            "description": "Enables a limit for the processing of sheets provided to the connector to the ones specified in the sheet index."
        }
    },
    "additionalProperties": false
}

User defined connector settings

uploadDgnRealityData

Boolean

Enables reality data upload to Reality Data API while synchronizing files to iModels, if .3sm, .3mx, .pod, or raster attachments are attached to CAD data. The default value is true.

convertDgnTerrainModels

Boolean

Enables terrain model elements to be processed during dgn-based synchronizations. The default value is false.

enableSheetsAndDrawings

Boolean

Controls sheets and drawings synchronization. The default value is false.

enableC3dGraphsIn2dModel

Boolean

squashIntermediateRevisions

Boolean

Enables the creation of a single Changeset for physical and drawing elements (2D, 3D) coming from all Source Files. Separate Changesets will be pushed for any schema or definition changes. The default value is false.

skipRvtReprojection

Boolean

Ignores geo-location defined in .rvt file and overlaps the model at the local iModel coordinates. The default value is false.

convertDgnHyperModelingSections

Boolean

Enables displaying the 2D section graphics and annotations in the context of the 3D model. The default value is true.

clampZExtent

Boolean

Enables a limit for the project Z extent maximum up to Mount Everest height (i.e.8849 meters). Works only when project extent in XY direction is defined for iModel. The default value is false.

overrideRvtReprojectionDistance

Integer

Define distance in meters when to start ignoring .rvt file geo-location data and reprojecting graphics based on local iModel coordinates. The default value is 0.

enableSheetIndex

Boolean

Enables processing of sheet index files from the associated workspace.

filterBySheetIndex

Boolean

Enables a limit for the processing of sheets provided to the connector to the ones specified in the sheet index.

reclassifyDgnElements

Boolean

Enables connector to change the base class of an element if its current classification comes from the Generic schema. The default value is false.

ignoreDgnAttachments

Boolean

Enables skipping of all reference attachments. As a result, only the master file is synchronized into the iModel. Only applicable for .dgn and .dwg files. The default value is false.

json

{
    "title": "User defined connector settings",
    "type": "object",
    "properties": {
        "uploadDgnRealityData": {
            "type": "boolean",
            "description": "Enables reality data upload to Reality Data API while synchronizing files to iModels, if .3sm, .3mx, .pod, or raster attachments are attached to CAD data. The default value is true."
        },
        "convertDgnTerrainModels": {
            "type": "boolean",
            "description": "Enables terrain model elements to be processed during dgn-based synchronizations. The default value is false."
        },
        "enableSheetsAndDrawings": {
            "type": "boolean",
            "description": "Controls sheets and drawings synchronization. The default value is false."
        },
        "enableC3dGraphsIn2dModel": {
            "type": "boolean",
            "description": "Separates Civil3d Connector 2D elements from 3D elements in the target iModel. The 2D elements will be inserted into a graph model while the 3D elements will be kept in the spatial model. The default value is false."
        },
        "squashIntermediateRevisions": {
            "type": "boolean",
            "description": "Enables the creation of a single Changeset for physical and drawing elements (2D, 3D) coming from all Source Files. Separate Changesets will be pushed for any schema or definition changes. The default value is false."
        },
        "skipRvtReprojection": {
            "type": "boolean",
            "description": "Ignores geo-location defined in .rvt file and overlaps the model at the local iModel coordinates. The default value is false."
        },
        "convertDgnHyperModelingSections": {
            "type": "boolean",
            "description": "Enables displaying the 2D section graphics and annotations in the context of the 3D model. The default value is true."
        },
        "clampZExtent": {
            "type": "boolean",
            "description": "Enables a limit for the project Z extent maximum up to Mount Everest height (i.e.8849 meters). Works only when project extent in XY direction is defined for iModel. The default value is false."
        },
        "overrideRvtReprojectionDistance": {
            "type": "integer",
            "description": "Define distance in meters when to start ignoring .rvt file geo-location data and reprojecting graphics based on local iModel coordinates. The default value is 0."
        },
        "enableSheetIndex": {
            "type": "boolean",
            "description": "Enables processing of sheet index files from the associated workspace."
        },
        "filterBySheetIndex": {
            "type": "boolean",
            "description": "Enables a limit for the processing of sheets provided to the connector to the ones specified in the sheet index."
        },
        "reclassifyDgnElements": {
            "type": "boolean",
            "description": "Enables connector to change the base class of an element if its current classification comes from the Generic schema. The default value is false."
        },
        "ignoreDgnAttachments": {
            "type": "boolean",
            "description": "Enables skipping of all reference attachments. As a result, only the master file is synchronized into the iModel. Only applicable for .dgn and .dwg files. The default value is false."
        }
    },
    "additionalProperties": false
}

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.

json

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

Error Response

Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.

error

Error

Error information.

json

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

Was this page helpful?