Get ManifestConnection SourceFiles - Synchronization

REST API Overview

Reference

Changelog

Synchronization

Download API definition:

Get ManifestConnection SourceFiles

GET https://api.bentley.com/synchronization/imodels/manifestconnections/{connectionId}/sourcefiles

Retrieves SourceFiles for specified ManifestConnection.

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 synchronization:read or itwin-platform.

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

Request

Request parameters

connectionId

template

Yes

Connection Id

Request headers

Authorization

Yes

OAuth access token with synchronization:read or 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",
            "sourceFileId": "t5bDFuN4qUa9ojVw1E5FGtldp8BgSbNCiJ2XMdiT-cA"
        },
        {
            "id": "5d22aa94-cde5-48ec-afcc-6c4aca67d51b",
            "sourceFileId": "t5bDFuN4qUa9ojVw1E5FGtldp8BgSbNCiJ2XMdiT-cA"
        }
    ],
    "_links": {
        "self": {
            "href": "https://api.bentley.com/synchronization/imodels/manifestconnections/{connectionId}/sourcefiles?$skip=100&$top=100"
        },
        "prev": {
            "href": "https://api.bentley.com/synchronization/imodels/manifestconnections/{connectionId}/sourcefiles?$skip=0&$top=100"
        },
        "next": {
            "href": "https://api.bentley.com/synchronization/imodels/manifestconnections/{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": "ManifestConnectionNotFound",
        "message": "Requested ManifestConnection is not available."
    }
}

Response 422 Unprocessable Entity

Invalid request to get connection sourcefiles.

json

{
    "error": {
        "code": "InvalidManifestConnectionSourceFilesRequest",
        "message": "Cannot perform operation.",
        "details": [{
                "code": "InvalidValue",
                "message": "Page size is over '1000' items limit.",
                "target": "$top"
            },
            {
                "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

retry-after

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

Definitions

ManifestFile (prefer return=minimal)

TableSchema

sourceFiles

manifest-file-summary[]

A list of sourceFiles representing a minimal number of properties.

ManifestFile (prefer return=representation)

TableSchema

sourceFiles

ManifestFile[]

A list of sourceFiles representing all file properties.

ManifestFile

TableSchema

String

Source file entity id.

sourceFileId

String

Source file id.

ManifestFile (summary)

TableSchema

String

Source file entity id.

sourceFileId

String

Source file id.

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.