Update StorageConnection SourceFile - Synchronization

REST API Overview

Reference

Changelog

Synchronization

Download API definition:

Update StorageConnection SourceFile

PUT https://api.bentley.com/synchronization/imodels/storageconnections/{connectionId}/sourcefiles/{sourceFileId}

Update an existing StorageConnection SourceFile.

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

SourceFile is related to a Connection. The path must contain a valid Connection ID.

Request parameters

connectionId

template

Yes

Connection Id

sourceFileId

template

Yes

Source File Id

Request headers

Authorization

Yes

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

Yes

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

Request body

StorageFile (create)

storageFileId

String

Yes

Storage file id.

connectorType

connector-type

Yes

Type of connector used for synchronization. Refer supported connector format for details.

Example

json

{
    "storageFileId": "u9E_00ckVU6sdWnH_vnk-bPJEu3c_VVItnIkNDWlTy0",
    "connectorType": "MSTN"
}

Response 200 OK

Connection sourceFile successfully updated.

json

{
    "sourceFile": {
        "id": "297c8ab9-53a3-4fe5-adf8-79b4c1a95cbb",
        "connectorType": "MSTN",
        "storageFileId": "t5bDFuN4qUa9ojVw1E5FGtldp8BgSbNCiJ2XMdiT-cA",
        "lastKnownFileName": "samplefile",
        "_links": {
            "file": {
                "href": "https://api.bentley.com/files/5db42812-ebb8-4c58-98a4-2eaa99e0d8b6"
            }
        }
    }
}

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 one of the associated entities could not be found.

json

{
    "error": {
        "code": "StorageConnectionSourceFileNotFound",
        "message": "Requested StorageConnectionSourceFile is not available."
    }
}

Response 422 Unprocessable Entity

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

json

{
    "error": {
        "code": "InvalidStorageConnectionSourceFileRequest",
        "message": "Cannot perform operation.",
        "details": [{
                "code": "InvalidRequestBody",
                "message": "Error parsing JSON, malformed JSON."
            },
            {
                "code": "MissingRequiredProperty",
                "message": "A property required to add or update  connection sourceFile is missing.",
                "target": "storageFileId"
            },
            {
                "code": "MissingRequiredProperty",
                "message": "A property required to add or update a connection sourceFile is missing.",
                "target": "connectorType"
            },
            {
                "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 storageFileId value is not valid.",
                "target": "storageFileId"
            }
        ]
    }
}

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

StorageFile response

TableSchema

sourceFile

StorageFile

Storage file entity.

StorageFile

TableSchema

String

Source file entity id.

storageFileId

String

Storage file id.

connectorType

connector-type

Type of connector used for synchronization. Refer supported connector format for details.

lastKnownFileName

String

Last known file name from data source.

_links

file-links

Link to the source file in storage API.

StorageFile (create)

TableSchema

storageFileId

String

Storage file id.

connectorType

connector-type

Type of connector used for synchronization. Refer supported connector format for details.

File Links

TableSchema

file

Link

Link to associated file.

Link

TableSchema

href

String

Hyperlink to the specific entity.

Connector type

One of 'AUTOPLANT', 'CIVIL', 'CIVIL3D', 'DWG', 'GEOSPATIAL', 'IFC', 'MSTN', 'NWD', 'OBD', 'OPENTOWER', 'REVIT', 'SPPID', 'SPXREVIEW'. Name of the Connector that is used for synchronization.

TableSchema

No data.

Error

Contains error information.

TableSchema

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

error

Error

Error information.