Get StorageConnection Run - Synchronization

Synchronization

Download API definition:

Get StorageConnection Run

GET https://qa-api.bentley.com/synchronization/imodels/storageconnections/{connectionId}/runs/{runId}

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

connectionId

Yes

Connection Id

runId

Yes

Run Id

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Response 200 OK

json

{
    "run": {
        "id": "a1ecbdc8c4f6173004f9f881914a57c5511a362b",
        "connectionId": "MWplZe9Uf0iR1IDMqyOMLqBN0_wHEVBGg_CzJmXdmE4",
        "startDateTime": "2020-10-24T02:44:13Z",
        "endDateTime": "2020-10-24T02:47:13Z",
        "phase": "MasterFile",
        "state": "Completed",
        "result": "PartialSuccess",
        "error": {
            "errorKey": "UserNotAuthenticated",
            "description": "User is not authenticated."
        },
        "jobs": [{
            "id": "d6ecbdc8c4f6173004f9f881914a57c5511a362b",
            "startDateTime": "2020-10-24T02:44:13Z",
            "endDateTime": "2020-10-24T02:44:13Z",
            "state": "Completed",
            "result": "PartialSuccess",
            "connectorType": "DWG",
            "tasks": [{
                "id": "f5ecbdc8c4f6173004f9f881914a57c5511a362b",
                "startDateTime": "2020-10-24T02:44:13Z",
                "endDateTime": "2020-10-24T02:44:13Z",
                "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
                    }
                }
            }]
        }]
    }
}

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 run was not found.

json

{
    "error": {
        "code": "StorageConnectionRunNotFound",
        "message": "Requested StorageConnectionRun is not available."
    }
}

Response 422 Unprocessable Entity

Invalid request to get connection run.

json

{
    "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.

json

{
    "error": {
        "code": "RateLimitExceeded",
        "message": "The client sent more requests than allowed by this API for the current tier of the client."
    }
}

Response headers

retry-after

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

Definitions

Error

Contains error information.

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.

json

{
    "required": [
        "code",
        "message"
    ],
    "type": "object",
    "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
        }
    },
    "description": "Contains error information."
}

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.

error

Error

json

{
    "title": "Error Response",
    "required": [
        "error"
    ],
    "type": "object",
    "properties": {
        "error": {
            "$ref": "#/components/schemas/Error"
        }
    },
    "additionalProperties": false,
    "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."
}

Execution State

One of 'NotStarted', 'Idle', 'WaitingToExecute', 'WaitingToRetry', 'Executing', 'Finalizing', 'Completed', 'Queued'.

NotStarted

String

Idle

String

WaitingToExecute

String

WaitingToRetry

String

Executing

String

Finalizing

String

Completed

String

Queued

String

json

{
    "title": "Execution State",
    "enum": [
        "NotStarted",
        "Idle",
        "WaitingToExecute",
        "WaitingToRetry",
        "Executing",
        "Finalizing",
        "Completed",
        "Queued"
    ],
    "type": "string",
    "description": "One of 'NotStarted', 'Idle', 'WaitingToExecute', 'WaitingToRetry', 'Executing', 'Finalizing', 'Completed', 'Queued'."
}

Execution Result

One of 'Undetermined', 'Success', 'Error', 'PartialSuccess', 'Skipped', 'Canceled', 'TimedOut'.

Undetermined

String

Success

String

Error

String

PartialSuccess

String

Skipped

String

Canceled

String

TimedOut

String

json

{
    "title": "Execution Result",
    "enum": [
        "Undetermined",
        "Success",
        "Error",
        "PartialSuccess",
        "Skipped",
        "Canceled",
        "TimedOut"
    ],
    "type": "string",
    "description": "One of 'Undetermined', 'Success', 'Error', 'PartialSuccess', 'Skipped', 'Canceled', 'TimedOut'."
}

Job Phase

One of 'Preprocessor', 'MasterFile', 'ReferenceFile'.

Preprocessor

String

MasterFile

String

ReferenceFile

String

json

{
    "title": "Job Phase",
    "enum": [
        "Preprocessor",
        "MasterFile",
        "ReferenceFile"
    ],
    "type": "string",
    "description": "One of 'Preprocessor', 'MasterFile', 'ReferenceFile'."
}

Run error details

errorKey

String

Error key.

description

String

More information about run error.

json

{
    "title": "Run error details",
    "type": "object",
    "properties": {
        "errorKey": {
            "type": "string",
            "description": "Error key."
        },
        "description": {
            "type": "string",
            "description": "More information about run error."
        }
    },
    "additionalProperties": false,
    "nullable": true
}

Connector type

One of 'AUTOPLANT', 'CIVIL', 'CIVIL3D', 'DWG', 'GEOSPATIAL', 'IFC', 'MSTN', 'NWD', 'OBD', 'OPENTOWER', 'REVIT', 'SPPID', 'SPXREVIEW', 'PROSTRUCTURES', 'RVM', 'PSEXCEL', 'INTELLIPID'. Name of the Connector that is used for synchronization.

AUTOPLANT

String

CIVIL

String

CIVIL3D

String

DWG

String

GEOSPATIAL

String

IFC

String

MSTN

String

NWD

String

OBD

String

OPENTOWER

String

REVIT

String

SPPID

String

SPXREVIEW

String

PROSTRUCTURES

String

RVM

String

PSEXCEL

String

INTELLIPID

String

json

{
    "title": "Connector type",
    "enum": [
        "AUTOPLANT",
        "CIVIL",
        "CIVIL3D",
        "DWG",
        "GEOSPATIAL",
        "IFC",
        "MSTN",
        "NWD",
        "OBD",
        "OPENTOWER",
        "REVIT",
        "SPPID",
        "SPXREVIEW",
        "PROSTRUCTURES",
        "RVM",
        "PSEXCEL",
        "INTELLIPID"
    ],
    "type": "string",
    "description": "One of 'AUTOPLANT', 'CIVIL', 'CIVIL3D', 'DWG', 'GEOSPATIAL', 'IFC', 'MSTN', 'NWD', 'OBD', 'OPENTOWER', 'REVIT', 'SPPID', 'SPXREVIEW', 'PROSTRUCTURES', 'RVM', 'PSEXCEL', 'INTELLIPID'. Name of the Connector that is used for synchronization."
}

task-error

errorCode

String

Error code.

message

String

A human-readable representation of the error.

details

String

More specific information about the error.

bridgeExitCode

Integer

An integer representing connector exit code.

system

String

System.

phase

String

Phase.

Suggested action

Error severity level

Error

String

Warning

String

Info

String

json

{
    "title": "Suggested action",
    "enum": [
        "Error",
        "Warning",
        "Info"
    ],
    "type": "string",
    "description": "Error severity level"
}

Synchronization report

suggestedAction

suggested-action

message

String

Error message explaining the result

totalErrorsCount

Integer

Number of errors in the report

totalWarningsCount

Integer

Number of warnings in the report

totalOtherIssuesCount

Integer

Number of other issues in the report

json

{
    "title": "Synchronization report",
    "type": "object",
    "properties": {
        "suggestedAction": {
            "$ref": "#/components/schemas/suggested-action"
        },
        "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
}

Task details

synchronizationReport

synchronization-report

json

{
    "title": "Task details",
    "type": "object",
    "properties": {
        "synchronizationReport": {
            "$ref": "#/components/schemas/synchronization-report"
        }
    },
    "additionalProperties": false
}

storage-task

String

A storage task id.

startDateTime

String

A timestamp when storage task started.

endDateTime

String

A timestamp when storage task ended.

retryAttempts

Integer

The number of attempts when storage task was retried.

storageFileId

String

Storage file id.

state

String

A string indicating current status of the storage task.

result

String

A string indicating outcome of the storage task.

error

task-error

details

task-details

json

{
    "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"
        },
        "details": {
            "$ref": "#/components/schemas/task-details"
        }
    },
    "additionalProperties": false
}

storage-job

String

A storage job id.

startDateTime

String

A timestamp when storage job started.

endDateTime

String

A timestamp when storage job ended.

state

String

A string indicating current execution status of the job.

result

String

A string indicating outcome of the executed job.

connectorType

connector-type

tasks

storage-task[]

An array of storage task entities.

json

{
    "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"
        },
        "tasks": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/storage-task"
            },
            "description": "An array of storage task entities."
        }
    },
    "additionalProperties": false
}

storage-run

String

A connection run id.

connectionId

String

Connection id.

startDateTime

String

A timestamp when connection run started.

endDateTime

String

A timestamp when connection run ended.

phase

state

result

error

jobs

An array of storage job entities.

json

{
    "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"
        },
        "state": {
            "$ref": "#/components/schemas/execution-state"
        },
        "result": {
            "$ref": "#/components/schemas/execution-result"
        },
        "error": {
            "$ref": "#/components/schemas/run-error-details"
        },
        "jobs": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/storage-job"
            },
            "description": "An array of storage job entities."
        }
    },
    "additionalProperties": false
}

Run response

run

storage-run

json

{
    "title": "Run response",
    "type": "object",
    "properties": {
        "run": {
            "$ref": "#/components/schemas/storage-run"
        }
    },
    "additionalProperties": false
}

Was this page helpful?