Create ExportConnection Run - Export

REST API Overview

Reference

Changelog

Export

Download API definition:

Create ExportConnection Run

POST https://api.bentley.com/export/connections/{connectionId}/runs

Runs the specified ExportConnection.

Notes

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. This API will return the current status and a redirect URL if the token has to be renewed.
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 page.

Request parameters

connectionId

template

Yes

Connection Id

Request headers

Authorization

Yes

OAuth access token with scope export:modify

Yes

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

Request body

Export Connection Run (Create)

exportType

export-type

Yes

Export type one of 'IFC' or 'LandXML'.

ifcVersion

ifc-version

IFC version one of  'IFC4.3', 'IFC2x3', 'IFC2x3 CV 2.0', 'IFC4 RV 1.2' if exportType is 'IFC'.

inputOptions

export-run-input-options

outputOptions

export-run-output-options

Example

json

{
    "exportType": "IFC",
    "ifcVersion": "IFC4.3",
    "inputOptions": {
        "mappingFileId": "0000000000000000000000000000000000000000",
        "changesetId": "0000000000000000000000000000000000000000",
        "savedViewId": "0000000000000000000000000000000000000000"
    },
    "outputOptions": {
        "location": "USER_BLOB_STORAGE",
        "outputSasUrl": "https://abc.com",
        "logsSasUrl": "https://abc.com",
        "folderId": "0000000000000000000000000000000000000000",
        "replaceOlderFile": true,
        "saveLogs": true
    }
}

Response 202 Accepted

Accepted

Response headers

Location

The resource location

Response 303 See Other

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

Response headers

Location

The resource location

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

json

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

Response 409 Conflict

A run request is already being processed.

json

{
    "error": {
        "code": "ConflictWithAnotherIModelRequest",
        "message": "This request is already being processed for this iModel."
    }
}

Response 422 Unprocessable Entity

Invalid request to create a 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

Export Type

One of 'IFC', 'LandXML'. Name of the file type to export to.

TableSchema

No data.

IFC Version

If the exportType is 'IFC', ifcVersion must be one of 'IFC4.3', 'IFC2x3', 'IFC2x3 CV 2.0', 'IFC4 RV 1.2'.

TableSchema

No data.

Export Connection Run (Create)

TableSchema

exportType

export-type

Export type one of 'IFC' or 'LandXML'.

ifcVersion

ifc-version

IFC version one of  'IFC4.3', 'IFC2x3', 'IFC2x3 CV 2.0', 'IFC4 RV 1.2' if exportType is 'IFC'.

inputOptions

export-run-input-options

outputOptions

export-run-output-options

Export Run Input Options

TableSchema

changesetId

String

Changeset Id if specific changeset is to be exported. By default the latest version of the iModel will be exported.

mappingFileId

String

User-Defined mapping file Id for IFC export (Storage API can be used to create/get files). By default, default mapping file will be used.

savedViewId

String

SavedView Id of the specific SavedView to be exported.

Export Run Output Options

TableSchema

location

Location type one of 'USERBLOBSTORAGE' or 'STORAGE'.

outputSasUrl

String

SASUrl to upload the output file to when the location is of type 'USERBLOBSTORAGE'.

logsSasUrl

String

SASUrl to upload the output log file to when the location is of type 'USERBLOBSTORAGE' and 'saveLogs' is set.

folderId

String

Folder Id to store the output file (Storage API can be used to create/get folders). By default, the file will be stored at the root folder of the project.

replaceOlderFile

Boolean

Set to replace the older file for same imodel.

saveLogs

Boolean

Set to save the logs of export.

Location

One of 'USER_BLOB_STORAGE', 'STORAGE'. Type of location to export to. Default is 'STORAGE' (Storage API).

TableSchema

No data.

Error

Contains error information.

TableSchema

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

error

Error

Error information.