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
Connection Id
Request headers
OAuth access token with itwin-platform
scope
Setting to application/vnd.bentley.itwin-platform.v1+json
is recommended.
Response 200 OK
OK
{ "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.
{ "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.
{ "error": { "code": "ManifestConnectionNotFound", "message": "Requested ManifestConnection is not available." } }
Response 422 Unprocessable Entity
Invalid request to get connection sourcefiles.
{ "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.
{ "error": { "code": "RateLimitExceeded", "message": "The client sent more requests than allowed by this API for the current tier of the client." } }
Response headers
Number of seconds to wait until client is allowed to make more requests.
ManifestFile (prefer return=minimal)
A list of sourceFiles representing a minimal number of properties.
{ "title": "ManifestFile (prefer return=minimal)", "type": "object", "properties": { "sourceFiles": { "type": "array", "items": { "$ref": "#/components/schemas/manifest-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 }
ManifestFile (prefer return=representation)
{ "title": "ManifestFile (prefer return=representation)", "type": "object", "properties": { "sourceFiles": { "type": "array", "items": { "$ref": "#/components/schemas/ManifestFile" }, "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 }
ManifestFile
Source file entity id.
Source file id.
{ "type": "object", "properties": { "id": { "type": "string", "description": "Source file entity id." }, "sourceFileId": { "type": "string", "description": "Source file id." } }, "additionalProperties": false }
ManifestFile (summary)
Source file entity id.
Source file id.
{ "title": "ManifestFile (summary)", "type": "object", "properties": { "id": { "type": "string", "description": "Source file entity id." }, "sourceFileId": { "type": "string", "description": "Source file id." } }, "additionalProperties": false }
Link
Hyperlink to the specific entity.
{ "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.
{ "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 }
Error
Contains error information.
One of a server-defined set of error codes.
A human-readable representation of the error.
The target of the error.
{ "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.
{ "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?