Table of contents
Export
Download API definition:
GET https://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

Name
In
Required?
Description
connectionId
template
Yes

Connection Id

runId
template
Yes

Run Id

Request headers

Name
Required?
Description
Authorization
Yes

OAuth access token with itwin-platform scope

Accept
Yes

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

Response 200 OK

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",
            "connectorType": "DWG",
            "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
                }
            }]
        }]
    }
}

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

Name
Description
retry-after

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

Run response

TableSchema
Name
Type
Description

export-run

TableSchema
Name
Type
Description
id
String
connectionId
String
startDateTime
String
endDateTime
String

export-job

TableSchema
Name
Type
Description
id
String
startDateTime
String
endDateTime
String
state
String
result
String

export-task

TableSchema
Name
Type
Description
id
String
startDateTime
String
endDateTime
String
retryAttempts
Integer
state
String
result
String

task-error

TableSchema
Name
Type
Description
errorCode
String
message
String
details
String
bridgeExitCode
Integer
system
String
phase
String
category
String
descriptionKey
String
description
String
kbArticleLink
String
canUserFix
Boolean

Execution State

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

TableSchema
Name
Type
Description
No data.

Execution Result

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

TableSchema
Name
Type
Description
No data.

Error

Contains error information.

TableSchema
Name
Type
Description
code
String

One of a server-defined set of error codes.

message
String

A human-readable representation of the error.

target
String

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.

TableSchema
Name
Type
Description
error

Error information.