Add StorageConnection SourceFile - Synchronization

Synchronization

Download API definition:

Add StorageConnection SourceFile

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

Add a new Storage Source File to a Storage Connection

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

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

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.

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": "t5bDFuN4qUa9ojVw1E5FGtldp8BgSbNCiJ2XMdiT-cA",
    "connectorType": "MSTN"
}

Response 201 Created

Storage Connection sourceFile successfully added.

json

{
    "sourceFile": {
        "id": "297c8ab9-53a3-4fe5-adf8-79b4c1a95cbb",
        "storageFileId": "t5bDFuN4qUa9ojVw1E5FGtldp8BgSbNCiJ2XMdiT-cA",
        "connectorType": "MSTN",
        "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 403 Forbidden

This response indicates that user does not have required permissions to create specified connection sourcefile.

json

{
    "error": {
        "code": "InsufficientPermissions",
        "message": "The user has insufficient permissions for the requested operation."
    }
}

Response 404 Not Found

This response indicates that the specified connection sourceFile was not found.

json

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

Response 409 Conflict

The SourceFile is already mapped to the iModel.

json

{
    "error": {
        "code": "FileMappingToTheIModelAlreadyExists",
        "message": "The SourceFile is already mapped to the iModel."
    }
}

Response 422 Unprocessable Entity

Invalid request to add 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 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

StorageFile response

sourceFile

StorageFile

Storage file entity.

json

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

StorageFile

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.

json

{
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "Source file entity id."
        },
        "storageFileId": {
            "type": "string",
            "description": "Storage file id."
        },
        "connectorType": {
            "$ref": "#/components/schemas/connector-type",
            "description": "Type of connector used for synchronization. Refer [supported connector format](https://dev-developer.bentley.com/apis/synchronization/supported-formats/) for details."
        },
        "lastKnownFileName": {
            "type": "string",
            "description": "Last known file name from data source."
        },
        "_links": {
            "$ref": "#/components/schemas/file-links",
            "description": "Link to the source file in storage API."
        }
    },
    "additionalProperties": false
}

StorageFile (create)

storageFileId

String

Storage file id.

connectorType

connector-type

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

json

{
    "title": "StorageFile (create)",
    "type": "object",
    "properties": {
        "storageFileId": {
            "type": "string",
            "description": "Storage file id."
        },
        "connectorType": {
            "$ref": "#/components/schemas/connector-type",
            "description": "Type of connector used for synchronization. Refer [supported connector format](https://dev-developer.bentley.com/apis/synchronization/supported-formats/) for details."
        }
    },
    "required": [
        "storageFileId",
        "connectorType"
    ],
    "additionalProperties": false
}

File Links

file

Link

Link to associated file.

json

{
    "title": "File Links",
    "type": "object",
    "properties": {
        "file": {
            "$ref": "#/components/schemas/Link",
            "description": "Link to associated file."
        }
    },
    "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
}

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.

AUTOPLANT

String

CIVIL

String

CIVIL3D

String

DWG

String

GEOSPATIAL

String

IFC

String

MSTN

String

NWD

String

OBD

String

OPENTOWER

String

REVIT

String

SPPID

String

SPXREVIEW

String

json

{
    "title": "Connector type",
    "type": "string",
    "description": "One of 'AUTOPLANT', 'CIVIL', 'CIVIL3D', 'DWG', 'GEOSPATIAL', 'IFC', 'MSTN', 'NWD', 'OBD', 'OPENTOWER', 'REVIT', 'SPPID', 'SPXREVIEW'. Name of the Connector that is used for synchronization.",
    "enum": [
        "AUTOPLANT",
        "CIVIL",
        "CIVIL3D",
        "DWG",
        "GEOSPATIAL",
        "IFC",
        "MSTN",
        "NWD",
        "OBD",
        "OPENTOWER",
        "REVIT",
        "SPPID",
        "SPXREVIEW"
    ]
}

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

StorageFile (create)

Example

Response

Response 201 Created

Response 401 Unauthorized

Response 403 Forbidden

Response 404 Not Found

Response 409 Conflict

Response 422 Unprocessable Entity

Response 429 Too many requests

Response headers

Definitions

StorageFile response

StorageFile

StorageFile (create)

File Links

Link

Connector type

Error

Error Response