Get ExportConnection Run - Export

REST API Overview

Reference

Changelog

Export

Download API definition:

Get ExportConnection Run

GET https://qa-api.bentley.com/export/connections/{connectionId}/runs/{runId}

Retrieves a ExportConnection 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": "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",
            "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.",
                    "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
                }
            }]
        }]
    }
}

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 403 Forbidden

This response indicates that user does not have required permissions to get specified connection run.

json

{
    "error": {
        "code": "InsufficientPermissions",
        "message": "The user has insufficient permissions for the requested operation."
    }
}

Response 404 Not Found

This response indicates that the specified connection run not found.

json

{
    "error": {
        "code": "ConnectionRunNotFound",
        "message": "Requested Connection Run is not available."
    }
}

Response 422 Unprocessable Entity

Invalid request to get connection run.

json

{
    "error": {
        "code": "InvalidConnectionRunRequest",
        "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.

json

{
    "error": {
        "code": "TooManyRequests",
        "message": "More requests were received than the subscription rate-limit allows."
    }
}

Response headers

retry-after

The number of requests exceeds the rate-limit for the client subscription.

Definitions

Run response

run

export-run

String

connectionId

String

startDateTime

String

endDateTime

String

state

execution-state

result

execution-result

jobs

export-job[]

export-job

String

startDateTime

String

endDateTime

String

state

String

result

String

tasks

export-task[]

export-task

String

startDateTime

String

endDateTime

String

retryAttempts

Integer

state

String

result

String

error

task-error

errorCode

String

message

String

details

String

bridgeExitCode

Integer

system

String

phase

String

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

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

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.

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.