Retrieves a StorageConnection Run with the specified ID.
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
Run 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
{ "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 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.
Run error details
Error key.
More information about run error.
{ "title": "Run error details", "type": "object", "nullable": true, "properties": { "errorKey": { "type": "string", "description": "Error key." }, "description": { "type": "string", "description": "More information about run error." } }, "additionalProperties": false }
Run response
{ "title": "Run response", "type": "object", "properties": { "run": { "$ref": "#/components/schemas/storage-run", "description": "Storage run entity." } }, "additionalProperties": false }
storage-run
A connection run id.
Connection id.
A timestamp when connection run started.
A timestamp when connection run ended.
{ "type": "object", "properties": { "id": { "type": "string", "description": "A connection run id." }, "connectionId": { "type": "string", "description": "Connection id." }, "startDateTime": { "type": "string", "description": "A timestamp when connection run started." }, "endDateTime": { "type": "string", "description": "A timestamp when connection run ended." }, "phase": { "$ref": "#/components/schemas/job-phase", "description": "Job phase." }, "state": { "$ref": "#/components/schemas/execution-state", "description": "A string indicating current execution status of the run." }, "result": { "$ref": "#/components/schemas/execution-result", "description": "A string indicating outcome of the executed run." }, "error": { "$ref": "#/components/schemas/run-error-details", "description": "Run error entity." }, "jobs": { "type": "array", "items": { "$ref": "#/components/schemas/storage-job" }, "description": "An array of storage job entities." } }, "additionalProperties": false }
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": "object", "properties": { "id": { "type": "string", "description": "A storage job id." }, "startDateTime": { "type": "string", "description": "A timestamp when storage job started." }, "endDateTime": { "type": "string", "description": "A timestamp when storage job ended." }, "state": { "type": "string", "description": "A string indicating current execution status of the job." }, "result": { "type": "string", "description": "A string indicating outcome of the executed job." }, "connectorType": { "$ref": "#/components/schemas/connector-type", "description": "Type of connector used for synchronization. Refer [supported connector format](https://dev-developer.bentley.com/apis/synchronization/supported-formats/) for details." }, "tasks": { "type": "array", "items": { "$ref": "#/components/schemas/storage-task" }, "description": "An array of storage task entities." } }, "additionalProperties": false }
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.
{ "type": "object", "properties": { "id": { "type": "string", "description": "A storage task id." }, "startDateTime": { "type": "string", "description": "A timestamp when storage task started." }, "endDateTime": { "type": "string", "description": "A timestamp when storage task ended." }, "retryAttempts": { "type": "integer", "description": "The number of attempts when storage task was retried." }, "storageFileId": { "type": "string", "description": "Storage file id." }, "state": { "type": "string", "description": "A string indicating current status of the storage task." }, "result": { "type": "string", "description": "A string indicating outcome of the storage task." }, "error": { "$ref": "#/components/schemas/task-error", "description": "Task error entity." }, "details": { "$ref": "#/components/schemas/task-details", "description": "Task result details." } }, "additionalProperties": false }
Job Phase
One of 'Preprocessor', 'MasterFile', 'ReferenceFile'.
{ "title": "Job Phase", "description": "One of 'Preprocessor', 'MasterFile', 'ReferenceFile'.", "type": "string", "enum": [ "Preprocessor", "MasterFile", "ReferenceFile" ] }
Execution State
One of 'NotStarted', 'Idle', 'WaitingToExecute', 'WaitingToRetry', 'Executing', 'Finalizing', 'Completed', 'Queued'.
{ "title": "Execution State", "description": "One of 'NotStarted', 'Idle', 'WaitingToExecute', 'WaitingToRetry', 'Executing', 'Finalizing', 'Completed', 'Queued'.", "type": "string", "enum": [ "NotStarted", "Idle", "WaitingToExecute", "WaitingToRetry", "Executing", "Finalizing", "Completed", "Queued" ] }
Execution Result
One of 'Undetermined', 'Success', 'Error', 'PartialSuccess', 'Skipped', 'Canceled', 'TimedOut'.
{ "title": "Execution Result", "description": "One of 'Undetermined', 'Success', 'Error', 'PartialSuccess', 'Skipped', 'Canceled', 'TimedOut'.", "type": "string", "enum": [ "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.
{ "type": "object", "properties": { "errorCode": { "type": "string", "description": "Error code." }, "message": { "type": "string", "description": "A human-readable representation of the error." }, "details": { "type": "string", "description": "More specific information about the error." }, "bridgeExitCode": { "type": "integer", "description": "An integer representing connector exit code." }, "system": { "type": "string", "description": "System." }, "phase": { "type": "string", "description": "Phase." }, "category": { "type": "string", "description": "Category." }, "descriptionKey": { "type": "string", "description": "Description key." }, "description": { "type": "string", "description": "Description." }, "kbArticleLink": { "type": "string", "description": "A link to public documentation for known errors." }, "canUserFix": { "type": "boolean", "description": "A boolean value representing if the error is user fixable or not." } }, "additionalProperties": false }
Task details
{ "type": "object", "title": "Task details", "properties": { "synchronizationReport": { "$ref": "#/components/schemas/synchronization-report", "description": "Synchronization result summary" } }, "additionalProperties": false }
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
{ "title": "Synchronization report", "type": "object", "properties": { "suggestedAction": { "$ref": "#/components/schemas/suggested-action", "description": "Most severe issue type" }, "message": { "type": "string", "description": "Error message explaining the result" }, "totalErrorsCount": { "type": "integer", "description": "Number of errors in the report" }, "totalWarningsCount": { "type": "integer", "description": "Number of warnings in the report" }, "totalOtherIssuesCount": { "type": "integer", "description": "Number of other issues in the report" } }, "additionalProperties": false }
Suggested action
Error severity level
{ "title": "Suggested action", "type": "string", "description": "Error severity level", "enum": [ "Error", "Warning", "Info" ] }
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.
{ "title": "Connector type", "type": "string", "description": "One of 'AUTOPLANT', 'CIVIL', 'CIVIL3D', 'DWG', 'GEOSPATIAL', 'IFC', 'MSTN', 'NWD', 'OBD', 'OPENTOWER', 'REVIT', 'SPPID', 'SPXREVIEW'. Name of the Connector that is used for synchronization.", "enum": [ "AUTOPLANT", "CIVIL", "CIVIL3D", "DWG", "GEOSPATIAL", "IFC", "MSTN", "NWD", "OBD", "OPENTOWER", "REVIT", "SPPID", "SPXREVIEW" ] }
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?