Table of contents
Synchronization
Download API definition:
GET https://dev-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 itwin-platform.

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

Request parameters

Name
Required?
Description
connectionId
Yes

Connection Id

Request headers

Name
Required?
Description
Authorization
Yes

OAuth access token with itwin-platform scope

Accept
Yes

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

Response 200 OK

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

Name
Description
retry-after

Number of seconds to wait until client is allowed to make more requests.

ManifestFile (prefer return=minimal)

Name
Type
Description
sourceFiles

A list of sourceFiles representing a minimal number of properties.

_links

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

ManifestFile (prefer return=representation)

Name
Type
Description
sourceFiles

A list of sourceFiles representing all file properties.

_links

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

ManifestFile

Name
Type
Description
id
String

Source file entity id.

sourceFileId
String

Source file id.

ManifestFile (summary)

Name
Type
Description
id
String

Source file entity id.

sourceFileId
String

Source file id.

Link

Name
Type
Description
href
String

Hyperlink to the specific entity.

Links (paging)

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

Name
Type
Description
self

URL for redoing the current request.

next

URL for getting the next page of results.

prev

URL for getting the previous page of results.

Error

Contains error information.

Name
Type
Description
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.

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.

Name
Type
Description
error

Error information.

Was this page helpful?