Retrieves a StorageConnection Run with the specified ID.
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 parameters
Connection Id
Run Id
Request headers
OAuth access token with synchronization:read or itwin-platform scope
Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.
Response 200 OK
OK
{ "run": { "id": "a1ecbdc8c4f6173004f9f881914a57c5511a362b", "connectionId": "MWplZe9Uf0iR1IDMqyOMLqBN0_wHEVBGg_CzJmXdmE4", "startDateTime": "2020-10-24T02:44:13.4109666Z", "endDateTime": "2020-10-24T02:47:13.4109666Z", "phase": "MasterFile", "state": "Completed", "result": "PartialSuccess", "error": { "errorKey": "UserNotAuthenticated", "description": "User is not authenticated." }, "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, "storageFileId": "g4ec1dc8c4f6173004f9f881914a57c5511a336d", "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 }, "details": { "synchronizationReport": { "suggestedAction": "Warning", "message": "", "totalErrorsCount": 0, "totalWarningsCount": 20, "totalOtherIssuesCount": 3 } } }] }] } }
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 run was not found.
{ "error": { "code": "StorageConnectionRunNotFound", "message": "Requested StorageConnectionRun is not available." } }
Response 422 Unprocessable Entity
Invalid request to get connection run.
{ "error": { "code": "InvalidStorageConnectionRunRequest", "message": "Cannot perform operation.", "details": [{ "code": "MissingRequiredParameter", "message": "imodelId was not provided.", "target": "imodelId" }, { "code": "InvalidValue", "message": "Provided imodelId value is not valid.", "target": "imodelId" }, { "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.
{ "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.
Run error details
Error key.
More information about run error.
storage-run
A connection run id.
Connection id.
A timestamp when connection run started.
A timestamp when connection run ended.
storage-job
A storage job id.
A timestamp when storage job started.
A timestamp when storage job ended.
A string indicating current execution status of the job.
A string indicating outcome of the executed job.
Type of connector used for synchronization. Refer supported connector format for details.
storage-task
A storage task id.
A timestamp when storage task started.
A timestamp when storage task ended.
The number of attempts when storage task was retried.
Storage file id.
A string indicating current status of the storage task.
A string indicating outcome of the storage task.
Job Phase
One of 'Preprocessor', 'MasterFile', 'ReferenceFile'.
Execution State
One of 'NotStarted', 'Idle', 'WaitingToExecute', 'WaitingToRetry', 'Executing', 'Finalizing', 'Completed', 'Queued'.
Execution Result
One of 'Undetermined', 'Success', 'Error', 'PartialSuccess', 'Skipped', 'Canceled', 'TimedOut'.
task-error
Error code.
A human-readable representation of the error.
More specific information about the error.
An integer representing connector exit code.
System.
Phase.
Category.
Description key.
Description.
A link to public documentation for known errors.
A boolean value representing if the error is user fixable or not.
Task details
Synchronization report
Error message explaining the result
Number of errors in the report
Number of warnings in the report
Number of other issues in the report
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.
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.