Export API is a cloud-based API meant to export the data from the iModels to other standard formats such as IFC or LandXML. It allows users export data from iModels which are hosted in Bentley's iModelHub to an IFC or LandXML file.

export

---

Retrieves a ExportConnection Run 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](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-export-connection-run

connectionId

runId

OAuth access token with scope `export:read`

Authorization

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

Accept

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.

application/json;InvalidAuthorizationScheme

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

This response indicates that the specified connection run not found.

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

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

retry-after

export-run-response

export-run

Run response

string

startDateTime

endDateTime

state

execution-state

result

execution-result

jobs

export-job

tasks

export-task

retryAttempts

integer

error

task-error

errorCode

message

details

bridgeExitCode

system

phase

descriptionKey

description

kbArticleLink

canUserFix

boolean

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

Execution State

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

Execution Result

Error

One of a server-defined set of error codes.

code

A human-readable representation of the error.

target

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.

ErrorResponse

Error Response

---

Retrieves the calling user's Authorization Information.

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-authorizationinformation

URL to redirect back to after authorization

redirectUrl

Invalid request to get authorization information.

---

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](https://developer.bentley.com/apis/overview/authorization/) page.

### Associated entities

A connection is linked with an iModel. An iModel ID is required to be set when creating a ExportConnection.

---


create-export-connection

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

Content-Type

OAuth access token with scope `export:modify`

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

application/json;InvalidExportConnectionRequest

---

Runs the specified ExportConnection.

### Notes

1. The export process usually takes time and is performed in the background. For that, we need to store the user's refresh token. The refresh token needs to be stored before calling the 'Create ExportConnection Run' end-point. You can get authorization information by using [Get Authorization Information API](https://developer.bentley.com/apis/export/operations/get-authorizationinformation/). This API will return the current status and a redirect URL if the token has to be renewed.

2. When a run is successfully created, the operation returns HTTP status code 202/accepted - the request is accepted for processing and will execute in background. The response will include a location header pointing to the created run. If an existing active run already exists for the iModel, a new run is not initiated, instead 303/see other is returned along with location header pointing to that existing active run. 
In the rare event that multiple create run requests are being made simultaneously, only the first request is processed and 409/conflict is returned for others.

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

---

create-export-connection-run

Location

This response indicates that an active run is in progress and link is provided in location header.

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

This response indicates that the specified connection not found.

A run request is already being processed.

Invalid request to create a connection run.

---

Delete connection

### 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](https://developer.bentley.com/apis/overview/authorization/) page.


---


delete-export-connection

This response indicates that the specified connection was not found.

---

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](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-export-connection

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

---

Retrieves export connections for the specified iModel.

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-export-connections

imodelId

The [$top](https://www.odata.org/getting-started/basic-tutorial/#topskip) system query option requests the number of items in the queried collection to be included in the result.

$top

The [$skip](https://www.odata.org/getting-started/basic-tutorial/#topskip) query option requests the number of items in the queried collection that are to be skipped and not included in the result.

$skip

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

---

Retrieves all ExportConnection Runs for the specified connection.

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-export-connection-runs

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

Get ExportConnection Run - Export | iTwin Platform

This tutorial guides you through exporting data from an iModel to other formats, such as IFC or LandXM using the Export API.

ExportConnections

Authentication

Request

Request parameters

Request headers

Response

Response 200 OK

Response 401 Unauthorized

Response 403 Forbidden

Response 404 Not Found

Response 422 Unprocessable Entity

Response 429 Too many requests

Definitions