Create ExportConnection Run - Export

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 itwin-platform.

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

Request parameters

connectionId

Yes

Connection Id

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Export Connection Run (Create)

exportType

export-type

Yes

Export type one of 'IFC'.

ifcVersion

ifc-version

IFC version one of 'IFC4.3' (IFC4.3_ADD2), '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",
        "mappingfileBlobUrl": "https://example.com"
    },
    "outputOptions": {
        "location": "USER_BLOB_STORAGE",
        "outputSasUrl": "https://abc.com",
        "logsSasUrl": "https://abc.com",
        "folderId": "0000000000000000000000000000000000000000",
        "replaceOlderFile": true,
        "saveLogs": true
    }
}

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 client sent more requests than allowed by this API for the current tier of the client.

json

{
    "error": {
        "code": "RateLimitExceeded",
        "message": "The client sent more requests than allowed by this API for the current tier of the client."
    }
}

Response headers

retry-after

Number of seconds to wait until client is allowed to make more requests.

Definitions

Export Type

Name of the file type to export to.

IFC

String

json

{
    "title": "Export Type",
    "type": "string",
    "description": "Name of the file type to export to.",
    "enum": [
        "IFC"
    ]
}

IFC Version

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

IFC4.3

String

IFC2x3

String

IFC2x3 CV 2.0

String

IFC4 RV 1.2

String

json

{
    "title": "IFC Version",
    "type": "string",
    "description": "If the exportType is 'IFC', ifcVersion must be one of 'IFC4.3' (IFC4.3_ADD2), 'IFC2x3', 'IFC2x3 CV 2.0', 'IFC4 RV 1.2'.",
    "enum": [
        "IFC4.3",
        "IFC2x3",
        "IFC2x3 CV 2.0",
        "IFC4 RV 1.2"
    ]
}

Export Connection Run (Create)

exportType

export-type

Export type one of 'IFC'.

ifcVersion

ifc-version

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

inputOptions

export-run-input-options

outputOptions

export-run-output-options

json

{
    "title": "Export Connection Run (Create)",
    "type": "object",
    "properties": {
        "exportType": {
            "$ref": "#/components/schemas/export-type",
            "description": "Export type one of 'IFC'."
        },
        "ifcVersion": {
            "$ref": "#/components/schemas/ifc-version",
            "description": "IFC version one of  'IFC4.3' (IFC4.3_ADD2), 'IFC2x3', 'IFC2x3 CV 2.0', 'IFC4 RV 1.2' if exportType is 'IFC'."
        },
        "inputOptions": {
            "$ref": "#/components/schemas/export-run-input-options"
        },
        "outputOptions": {
            "$ref": "#/components/schemas/export-run-output-options"
        }
    },
    "required": [
        "exportType"
    ],
    "additionalProperties": false
}

Export Run Input Options

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. (Note - For 'Service' authenticationType, the SavedView must be shared)

mappingfileBlobUrl

String

User-Defined mapping file SASUrl for IFC export. If not specified by default, default mapping file will be used.

json

{
    "title": "Export Run Input Options",
    "type": "object",
    "properties": {
        "changesetId": {
            "type": "string",
            "description": "Changeset Id if specific changeset is to be exported. By default the latest version of the iModel will be exported."
        },
        "mappingFileId": {
            "type": "string",
            "description": "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": {
            "type": "string",
            "description": "SavedView Id of the specific SavedView to be exported. (Note - For 'Service' authenticationType, the SavedView must be shared)"
        },
        "mappingfileBlobUrl": {
            "type": "string",
            "description": "User-Defined mapping file SASUrl for IFC export. If not specified by default, default mapping file will be used."
        }
    },
    "additionalProperties": false
}

Export Run Output Options

location

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

outputSasUrl

String

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

logsSasUrl

String

SASUrl to upload the output log file to when the location is of type 'USER_BLOB_STORAGE' 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.

json

{
    "title": "Export Run Output Options",
    "type": "object",
    "properties": {
        "location": {
            "$ref": "#/components/schemas/location",
            "description": "Location type one of 'USER_BLOB_STORAGE' or 'STORAGE'."
        },
        "outputSasUrl": {
            "type": "string",
            "description": "SASUrl to upload the output file to when the location is of type 'USER_BLOB_STORAGE'."
        },
        "logsSasUrl": {
            "type": "string",
            "description": "SASUrl to upload the output log file to when the location is of type 'USER_BLOB_STORAGE' and 'saveLogs' is set."
        },
        "folderId": {
            "type": "string",
            "description": "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": {
            "type": "boolean",
            "description": "Set to replace the older file for same imodel."
        },
        "saveLogs": {
            "type": "boolean",
            "description": "Set to save the logs of export."
        }
    },
    "additionalProperties": false
}

Location

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

USER_BLOB_STORAGE

String

STORAGE

String

json

{
    "title": "Location",
    "type": "string",
    "description": "One of 'USER_BLOB_STORAGE', 'STORAGE'. Type of location to export to. Default is 'STORAGE' (Storage API).",
    "enum": [
        "USER_BLOB_STORAGE",
        "STORAGE"
    ]
}

Error

Contains error information.

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String, null

The target of the error.

json

{
    "type": "object",
    "description": "Contains error information.",
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        },
        "target": {
            "type": "string",
            "description": "The target of the error.",
            "nullable": true
        }
    },
    "required": [
        "code",
        "message"
    ],
    "additionalProperties": true
}

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.

error

Error

Error information.

json

{
    "type": "object",
    "title": "Error Response",
    "description": "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.",
    "properties": {
        "error": {
            "description": "Error information.",
            "$ref": "#/components/schemas/Error"
        }
    },
    "required": [
        "error"
    ],
    "additionalProperties": false
}

Was this page helpful?

Notes

Authentication

Request

Request parameters

Request headers

Request body

Export Connection Run (Create)

Example

Response

Response 202 Accepted

Response headers

Response 303 See Other

Response headers

Response 401 Unauthorized

Response 403 Forbidden

Response 404 Not Found

Response 409 Conflict

Response 422 Unprocessable Entity

Response 429 Too many requests

Response headers

Definitions

Export Type

IFC Version

Export Connection Run (Create)

Export Run Input Options

Export Run Output Options

Location

Error

Error Response