Table of contents
Export
Download API definition:
GET https://api.bentley.com/export/connections/{connectionId}

Retrieves a ExportConnection with the specified ID.

Authentication

Requires Authorization header with valid Bearer token for scope export:read.

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

Request headers

Name
Required?
Description
Authorization
Yes

OAuth access token with scope export:read

Accept
Yes

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

Response 200 OK

OK

json
{
    "connection": {
        "id": "fc226d0d-1647-48d7-8c11-f1f74f2d9808",
        "iModelId": "7dbd531d-6967-47b2-8945-a722a437ad7a",
        "iTwinId": "7dbd531d-6967-47b2-8945-a722a437ad7a",
        "displayName": "30",
        "authenticationType": "User",
        "_links": {
            "iModel": {
                "href": "https://api.bentley.com/imodels/5db42812-ebb8-4c58-98a4-2eaa99e0d8b6"
            },
            "iTwin": {
                "href": "https://api.bentley.com/itwins/4tb42812-ebb8-4c58-98a4-2eaa99e0d8b6"
            },
            "lastRun": {
                "href": "https://api.bentley.com/export/connections/fc226d0d-1647-48d7-8c11-f1f74f2d9808/runs/de626d0d-1647-48d7-8c11-f1f74f2d4523"
            }
        }
    }
}

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.

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

json
{
    "error": {
        "code": "ConnectionNotFound",
        "message": "Requested Connection is not available."
    }
}

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.

Link

TableSchema
Name
Type
Description
href
String

Authentication Type

One of 'User' or 'Service'

TableSchema
Name
Type
Description
No data.

Connection Links

TableSchema
Name
Type
Description
iModel
project
lastRun

Export Connection Response

TableSchema
Name
Type
Description

Export Connection

TableSchema
Name
Type
Description
authenticationType
id
String
displayName
String
iModelId
String

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.