Retrieves all ExportConnection Runs for the specified connection.
Authentication
Requires Authorization header with valid Bearer token for scope export:read.
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 scope export:read
Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.
Response 200 OK
OK
{ "runs": [{ "id": "a1ecbdc8c4f6173004f9f881914a57c5511a362b", "connectionId": "bc38cd8a-fd9f-4abf-9ad7-0c3b3d28720e", "startDateTime": "2020-10-24T02:44:13.4109666Z", "endDateTime": "2020-10-24T02:47:13.4109666Z", "state": "Completed", "result": "PartialSuccess", "jobs": [{ "id": "d6ecbdc8c4f6173004f9f881914a57c5511a362b", "startDateTime": "2020-10-24T02:44:13.4109666Z", "endDateTime": "2020-10-24T02:44:13.4109666Z", "state": "Completed", "result": "PartialSuccess", "connectorType": "DWG", "tasks": [{ "id": "f5ecbdc8c4f6173004f9f881914a57c5511a362b", "startDateTime": "2020-10-24T02:44:13.4109666Z", "endDateTime": "2020-10-24T02:44:13.4109666Z", "retryAttempts": 0, "state": "Completed", "result": "Success", "error": { "errorCode": "TAE_BRG_1000", "message": "Failed to process the file.", "details": "Error exit code received from bridge wrapper.", "bridgeExitCode": 4294967295, "system": "cloud_orchestrator", "phase": "internal_server_error", "category": "other", "descriptionKey": "RunOrchestrationError", "description": "Failed to orchestrate Run.", "kbArticleLink": "", "canUserFix": false } }] }] }], "_links": { "self": { "href": "https://api.bentley.com/export/connections/{connectionId}/runs?$skip=100&$top=100" }, "prev": { "href": "https://api.bentley.com/export/connections/{connectionId}/runs?$skip=0&$top=100" }, "next": { "href": "https://api.bentley.com/export/connections/{connectionId}/runs?$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 403 Forbidden
This response indicates that user does not have required permissions to get specified connection runs.
{ "error": { "code": "InsufficientPermissions", "message": "The user has insufficient permissions for the requested operation." } }
Response 422 Unprocessable Entity
Invalid request to get connection.
{ "error": { "code": "InvalidConnectionRunsRequest", "message": "Cannot perform operation.", "details": [{ "code": "MissingRequiredParameter", "message": "imodelId was not provided.", "target": "imodelId" }, { "code": "InvalidValue", "message": "Page size is out of limits.", "target": "$top" }, { "code": "InvalidValue", "message": "Provided imodelId value is not valid.", "target": "imodelId" } ] } }
Response 429 Too many requests
This response indicates that the user has sent too many requests in a given amount of time.
{ "error": { "code": "TooManyRequests", "message": "More requests were received than the subscription rate-limit allows." } }
The number of requests exceeds the rate-limit for the client subscription.
Link
export-run
export-job
export-task
task-error
Execution State
One of 'NotStarted', 'Idle', 'WaitingToExecute', 'WaitingToRetry', 'Executing', 'Finalizing', 'Completed', 'Queued'.
Execution Result
One of 'Undetermined', 'Success', 'Error', 'PartialSuccess', 'Skipped', 'Canceled', 'TimedOut'.
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.
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.