Table of contents
Export

ExportConnections

Download API definition:

POST https://api.bentley.com/export/connections

Create a ExportConnection that describes which iModel's data is to be exported.

Authentication

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

For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.

Associated entities

A connection is linked with an iModel. An iModel ID is required to be set when creating a ExportConnection.

Request headers

Name
Required?
Description
Content-Type
No

Indicates request body content type. Supported media type is application/json.

Authorization
Yes

OAuth access token with scope export:modify

Accept
Yes

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

Request body

Export Connection (create)

Name
Type
Required?
Description
authenticationType
No
displayName
String
No
iModelId
String
Yes

Example

json

Response 201 Created

Connection successfully created.

json

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

Response 422 Unprocessable Entity

Invalid request to create connection. Request payload might be missing some of the required properties.

json

Response 429 Too many requests

This response indicates that the user has sent too many requests in a given amount of time.

json

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

Export Connection (create)

TableSchema
Name
Type
Description
authenticationType
displayName
String
iModelId
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.