Table of contents
Synchronization
Download API definition:
PUT https://api.bentley.com/synchronization/imodels/storageconnections/{connectionId}

Update an existing StorageConnection.

Authentication

Requires Authorization header with valid Bearer token for scope synchronization:modify or itwin-platform.

For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.

Associated entities

A connection is linked with an iModel. The iModel ID is required to be set when updating a StorageConnection.

Request parameters

Name
In
Required?
Description
connectionId
template
Yes

Connection Id

Request headers

Name
Required?
Description
Authorization
Yes

OAuth access token with synchronization:modify or itwin-platform scope

Accept
Yes

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

Request body

Storage Connection (update)

Name
Type
Required?
Description
authenticationType
No

A type used for defining authorization workflow for this connection. Default is user.

displayName
String
No

A storage connection display name.

Example

json
{
    "displayName": "30",
    "authenticationType": "User"
}

Response 200 OK

Connection successfully updated.

json
{
    "connection": {
        "id": "MWplZe9Uf0iR1IDMqyOMLuL24kbZK4VNvgn4ev3etXI",
        "iModelId": "7dbd531d-6967-47b2-8945-a722a437ad7a",
        "iTwinId": "5fb9aa98-9874-4697-b942-d19728840f19",
        "authenticationType": "User",
        "displayName": "30",
        "_links": {
            "iModel": {
                "href": "https://api.bentley.com/imodels/v1/7dbd531d-6967-47b2-8945-a722a437ad7a"
            },
            "iTwin": {
                "href": "https://api.bentley.com/itwins/v1/5fb9aa98-9874-4697-b942-d19728840f19"
            },
            "lastRun": {
                "href": "https://api.bentley.com/synchronization/imodels/storageconnections/MWplZe9Uf0iR1IDMqyOMLuL24kbZK4VNvgn4ev3etXI/runs/de626d0d-1647-48d7-8c11-f1f74f2d4523"
            }
        }
    }
}

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

This response indicates that the specified connection was not found.

json
{
    "error": {
        "code": "StorageConnectionNotFound",
        "message": "Requested StorageConnection is not available."
    }
}

Response 422 Unprocessable Entity

Invalid request to update connection. Request payload might be missing some of the required properties.

json
{
    "error": {
        "code": "InvalidStorageConnectionRequest",
        "message": "Cannot perform operation.",
        "details": [{
                "code": "InvalidRequestBody",
                "message": "Error parsing JSON, malformed JSON."
            },
            {
                "code": "MissingRequiredProperty",
                "message": "A property required to create or update a connection is missing.",
                "target": "sourceFiles"
            },
            {
                "code": "MissingRequiredProperty",
                "message": "A property required to create or update a connection is missing.",
                "target": "connectorType"
            },
            {
                "code": "MissingRequiredProperty",
                "message": "A property required to create or update a connection is missing.",
                "target": "storageFileId"
            },
            {
                "code": "InvalidValue",
                "message": "connectorType must be one of: 'AUTOPLANT', 'CIVIL', 'CIVIL3D', 'DACQJSON', 'DWG', 'GEOSPATIAL', 'IFC', 'INTELLIPID', 'MSTN', 'NWD', 'OBD', 'OPENTOWER', 'PROSTRUCTURES', 'PSEXCEL', 'REVIT', 'SPPID', 'SPXREVIEW'.",
                "target": "connectorType"
            },
            {
                "code": "InvalidValue",
                "message": "Provided connectionId value is not valid.",
                "target": "connectionId"
            }
        ]
    }
}

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

Name
Description
retry-after

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

Storage Connection

TableSchema
Name
Type
Description
authenticationType

A type used for defining authorization workflow for this connection. Default is user.

id
String

Storage connection id.

displayName
String

A storage connection display name.

iModelId
String

iModel id.

_links

A set of links to iModel, iTwin, and the latest connection run.

Storage connection response

TableSchema
Name
Type
Description
connection

Storage connection entity.

Storage Connection (update)

TableSchema
Name
Type
Description
authenticationType

A type used for defining authorization workflow for this connection. Default is user.

displayName
String

A storage connection display name.

Authentication Type

One of 'User' or 'Service'.

TableSchema
Name
Type
Description
No data.

Connection Links

TableSchema
Name
Type
Description
iModel

Link to iModel.

iTwin

Link to iTwin.

lastRun

Link to latest run for a connection.

Link

TableSchema
Name
Type
Description
href
String

Hyperlink to the specific entity.

Error

Contains error information.

TableSchema
Name
Type
Description
code
String

One of a server-defined set of error codes.

message
String

A human-readable representation of the error.

target
String

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.

TableSchema
Name
Type
Description
error

Error information.