Get StorageConnection Runs - Synchronization

Synchronization

Download API definition:

GET https://api.bentley.com/synchronization/imodels/storageconnections/{connectionId}/runs[?$top][&$skip]

Retrieves all Runs for the specified connection.

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

Request parameters

connectionId

Yes

Connection Id

$top

The $top system query option requests the number of items in the queried collection to be included in the result.

$skip

The $skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Response

Response 200 OK

json

{
    "runs": [{
        "id": "a1ecbdc8c4f6173004f9f881914a57c5511a362b",
        "state": "Completed",
        "result": "PartialSuccess"
    }],
    "_links": {
        "self": {
            "href": "https://api.bentley.com/synchronization/imodels/connection/{connectionId}/runs?$skip=100&$top=100"
        },
        "prev": {
            "href": "https://api.bentley.com/synchronization/imodels/connection/{connectionId}/runs?$skip=0&$top=100"
        },
        "next": {
            "href": "https://api.bentley.com/synchronization/imodels/connection/{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.

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

json

{
    "error": {
        "code": "StorageConnectionNotFound",
        "message": "Requested StorageConnection is not available."
    }
}

Response 422 Unprocessable Entity

Invalid request to get connection.

json

{
    "error": {
        "code": "InvalidStorageConnectionRunsRequest",
        "message": "Cannot perform operation.",
        "details": [{
                "code": "InvalidValue",
                "message": "Page size is out of limits.",
                "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.

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

Runs (prefer return=minimal)

runs

run-summary[]

A set of storage run entities representing a minimal number of properties.

_links

Links

Links to current, previous, and next set of runs.

json

{
    "title": "Runs (prefer return=minimal)",
    "type": "object",
    "properties": {
        "runs": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/run-summary"
            },
            "description": "A set of storage run entities representing a minimal number of properties."
        },
        "_links": {
            "$ref": "#/components/schemas/Links",
            "description": "Links to current, previous, and next set of runs."
        }
    },
    "additionalProperties": false
}

Run error details

errorKey

String

Error key.

description

String

More information about run error.

json

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

Runs (prefer return=representation)

runs

storage-run[]

A set of storage run entities representing all storage run properties.

_links

Links

Links to current, previous, and next set of runs.

json

{
    "title": "Runs (prefer return=representation)",
    "type": "object",
    "properties": {
        "runs": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/storage-run"
            },
            "description": "A set of storage run entities representing all storage run properties."
        },
        "_links": {
            "$ref": "#/components/schemas/Links",
            "description": "Links to current, previous, and next set of runs."
        }
    },
    "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

job-phase

Job phase.

state

execution-state

A string indicating current execution status of the run.

result

execution-result

A string indicating outcome of the executed run.

error

run-error-details

Run error entity.

jobs

storage-job[]

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",
            "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

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

Type of connector used for synchronization. Refer supported connector format for details.

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",
            "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

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

Task error entity.

details

task-details

Task result 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",
            "description": "Task error entity."
        },
        "details": {
            "$ref": "#/components/schemas/task-details",
            "description": "Task result details."
        }
    },
    "additionalProperties": false
}

Job Phase

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

Preprocessor

String

MasterFile

String

ReferenceFile

String

json

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

NotStarted

String

Idle

String

WaitingToExecute

String

WaitingToRetry

String

Executing

String

Finalizing

String

Completed

String

Queued

String

json

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

Undetermined

String

Success

String

Error

String

PartialSuccess

String

Skipped

String

Canceled

String

TimedOut

String

json

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

Run (summary)

String

A run id.

state

String

A string indicating current status of the run.

result

String

A string indicating outcome of the run.

json

{
    "title": "Run (summary)",
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "A run id."
        },
        "state": {
            "type": "string",
            "description": "A string indicating current status of the run."
        },
        "result": {
            "type": "string",
            "description": "A string indicating outcome of the run."
        }
    },
    "additionalProperties": false
}

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.

Task details

synchronizationReport

synchronization-report

Synchronization result summary

json

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

Synchronization report

suggestedAction

suggested-action

Most severe issue type

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",
            "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

Error

String

Warning

String

Info

String

json

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

Link

href

String

Hyperlink to the specific entity.

json

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

self

Link

URL for redoing the current request.

Link

URL for getting the next page of results.

Link

URL for getting the previous page of results.

json

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

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.

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

json

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

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

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

error

Error

Error information.

json

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