Update StorageConnection - Synchronization

Synchronization

Download API definition:

Update StorageConnection

PUT https://dev-api.bentley.com/synchronization/imodels/storageconnections/{connectionId}

Update an existing StorageConnection.

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.

Associated entities

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

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.

Storage Connection (update)

authenticationType

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

displayName

String

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

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

Storage Connection

authenticationType

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

String

Storage connection id.

displayName

String

A storage connection display name.

iModelId

String

iModel id.

iTwinId

String

iTwin id.

_links

connection-links

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

json

{
    "title": "Storage Connection",
    "type": "object",
    "properties": {
        "authenticationType": {
            "$ref": "#/components/schemas/authenticationType",
            "description": "A type used for defining authorization workflow for this connection. Default is user."
        },
        "id": {
            "type": "string",
            "description": "Storage connection id."
        },
        "displayName": {
            "type": "string",
            "description": "A storage connection display name."
        },
        "iModelId": {
            "type": "string",
            "description": "iModel id."
        },
        "iTwinId": {
            "type": "string",
            "description": "iTwin id."
        },
        "_links": {
            "$ref": "#/components/schemas/connection-links",
            "description": "A set of links to iModel, iTwin, and the latest connection run."
        }
    },
    "additionalProperties": false
}

Storage connection response

connection

StorageConnection

Storage connection entity.

json

{
    "title": "Storage connection response",
    "type": "object",
    "properties": {
        "connection": {
            "$ref": "#/components/schemas/StorageConnection",
            "description": "Storage connection entity."
        }
    },
    "additionalProperties": false
}

Storage Connection (update)

authenticationType

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

displayName

String

A storage connection display name.

json

{
    "title": "Storage Connection (update)",
    "type": "object",
    "properties": {
        "authenticationType": {
            "$ref": "#/components/schemas/authenticationType",
            "description": "A type used for defining authorization workflow for this connection. Default is user."
        },
        "displayName": {
            "type": "string",
            "description": "A storage connection display name."
        }
    },
    "additionalProperties": false
}

Authentication Type

One of 'User' or 'Service'.

User

String

Service

String

json

{
    "title": "Authentication Type",
    "description": "One of 'User' or 'Service'.",
    "type": "string",
    "enum": [
        "User",
        "Service"
    ]
}

Connection Links

iModel

Link

Link to iModel.

iTwin

Link

Link to iTwin.

lastRun

Link

Link to latest run for a connection.

json

{
    "title": "Connection Links",
    "type": "object",
    "properties": {
        "iModel": {
            "$ref": "#/components/schemas/Link",
            "description": "Link to iModel."
        },
        "iTwin": {
            "$ref": "#/components/schemas/Link",
            "description": "Link to iTwin."
        },
        "lastRun": {
            "$ref": "#/components/schemas/Link",
            "description": "Link to latest run for a connection."
        }
    },
    "additionalProperties": false
}

Link

href

String

Hyperlink to the specific entity.

json

{
    "type": "object",
    "properties": {
        "href": {
            "type": "string",
            "description": "Hyperlink to the specific entity."
        }
    },
    "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?

Authentication

Associated entities

Request

Request parameters

Request headers

Request body

Storage Connection (update)

Example

Response

Response 200 OK

Response 401 Unauthorized

Response 404 Not Found

Response 422 Unprocessable Entity

Response 429 Too many requests

Response headers

Definitions

Storage Connection

Storage connection response

Storage Connection (update)

Authentication Type

Connection Links

Link

Error

Error Response