Get StorageConnection SourceFiles - Synchronization

Synchronization

Download API definition:

GET https://api.bentley.com/synchronization/imodels/storageconnections/{connectionId}/sourcefiles[?$top][&$skip]

Retrieves SourceFiles for specified StorageConnection.

Notes

The Prefer header can be used to specify how much result metadata is desired by the client. The Prefer request header field is used to indicate that particular server behaviors are preferred by the client but are not required for successful completion of the request.

This operation supports "return=representation" and "return=minimal" preferences.

The "return=representation" preference indicates that the client prefers that the server include an entity representing the current state of the resource in the response to a successful request. The "return=minimal" preference indicates that the client wishes the server to return only a minimal response to a successful request. This is the default preference if Prefer header is not specified.

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

$top

The $top system query option requests the number of items in the queried collection to be included in the result.

$skip

The $skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Response

Response 200 OK

json

{
    "sourceFiles": [{
            "id": "297c8ab9-53a3-4fe5-adf8-79b4c1a95cbb",
            "storageFileId": "t5bDFuN4qUa9ojVw1E5FGtldp8BgSbNCiJ2XMdiT-cA",
            "lastKnownFileName": "samplefile",
            "_links": {
                "file": {
                    "href": "https://api.bentley.com/files/t5bDFuN4qUa9ojVw1E5FGtldp8BgSbNCiJ2XMdiT-cA"
                }
            }
        },
        {
            "id": "5d22aa94-cde5-48ec-afcc-6c4aca67d51b",
            "storageFileId": "t5bDFuN4qUa9ojVw1E5FGtldp8BgSbNCiJ2XMdiT-cA",
            "lastKnownFileName": "samplefile",
            "_links": {
                "file": {
                    "href": "https://api.bentley.com/files/t5bDFuN4qUa9ojVw1E5FGtldp8BgSbNCiJ2XMdiT-cA"
                }
            }
        }
    ],
    "_links": {
        "self": {
            "href": "https://api.bentley.com/synchronization/imodels/storageconnections/{connectionId}/sourcefiles?$skip=100&$top=100"
        },
        "prev": {
            "href": "https://api.bentley.com/synchronization/imodels/storageconnections/{connectionId}/sourcefiles?$skip=0&$top=100"
        },
        "next": {
            "href": "https://api.bentley.com/synchronization/imodels/storageconnections/{connectionId}/sourcefiles?$skip=200&$top=100"
        }
    }
}

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 get connection sourcefiles.

json

{
    "error": {
        "code": "InvalidStorageConnectionSourceFilesRequest",
        "message": "Cannot perform operation.",
        "details": [{
            "code": "InvalidValue",
            "message": "Page size is out of limits.",
            "target": "$top"
        }]
    }
}

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 (prefer return=minimal)

sourceFiles

storage-file-summary[]

A list of sourceFiles representing a minimal number of properties.

_links

Links

Links to current, previous, and next set of sourcefiles.

json

{
    "title": "StorageFile (prefer return=minimal)",
    "type": "object",
    "properties": {
        "sourceFiles": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/storage-file-summary"
            },
            "description": "A list of sourceFiles representing a minimal number of properties."
        },
        "_links": {
            "$ref": "#/components/schemas/Links",
            "description": "Links to current, previous, and next set of sourcefiles."
        }
    },
    "additionalProperties": false
}

StorageFile (prefer return=representation)

sourceFiles

StorageFile[]

A list of sourceFiles representing all file properties.

_links

Links

Links to current, previous, and next set of sourcefiles.

json

{
    "title": "StorageFile (prefer return=representation)",
    "type": "object",
    "properties": {
        "sourceFiles": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/StorageFile"
            },
            "description": "A list of sourceFiles representing all file properties."
        },
        "_links": {
            "$ref": "#/components/schemas/Links",
            "description": "Links to current, previous, and next set of sourcefiles."
        }
    },
    "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 (summary)

String

Source file entity id.

storageFileId

String

Storage file id.

lastKnownFileName

String

Last known file name from data source.

_links

file-links

Link to the source file in storage API.

json

{
    "title": "StorageFile (summary)",
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "Source file entity id."
        },
        "storageFileId": {
            "type": "string",
            "description": "Storage file id."
        },
        "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
}

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
}

Links (paging)

URLs for redoing the current request, getting to the previous or next page of results.

self

Link

URL for redoing the current request.

Link

URL for getting the next page of results.

Link

URL for getting the previous page of results.

json

{
    "title": "Links (paging)",
    "type": "object",
    "description": "URLs for redoing the current request, getting to the previous or next page of results.",
    "properties": {
        "self": {
            "$ref": "#/components/schemas/Link",
            "description": "URL for redoing the current request."
        },
        "next": {
            "$ref": "#/components/schemas/Link",
            "description": "URL for getting the next page of results."
        },
        "prev": {
            "$ref": "#/components/schemas/Link",
            "description": "URL for getting the previous page of results."
        }
    },
    "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?