• Get Started
  • Documentation
  • Samples
  • Blog
  • Pricing
    • Free Trial
    Table of contents
    Overview
    Tutorials
    Samples
    Changelog
    Export
    Download API definition:
    Create ExportConnection Run
    POST https://qa-api.bentley.com/export/connections/{connectionId}/runs

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

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

    Request

    Request parameters

    Name
    Required?
    Description
    connectionId
    Yes

    Connection Id

    Request headers

    Name
    Required?
    Description
    Authorization
    Yes

    OAuth access token with itwin-platform scope

    Accept
    Yes

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

    Request body

    Export Connection Run (Create)

    Name
    Type
    Required?
    Description
    exportType
    export-type
    Yes

    Export type one of 'IFC'.

    ifcVersion
    ifc-version
    No

    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
    No
    outputOptions
    export-run-output-options
    No

    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

    Response 202 Accepted

    Accepted

    Response headers

    Name
    Description
    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

    Name
    Description
    Location

    The resource location

    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 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

    Name
    Description
    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.

    Name
    Type
    Description
    IFC
    String

    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'.

    Name
    Type
    Description
    IFC4.3
    String
    IFC2x3
    String
    IFC2x3 CV 2.0
    String
    IFC4 RV 1.2
    String

    Export Connection Run (Create)

    Name
    Type
    Description
    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

    Export Run Input Options

    Name
    Type
    Description
    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.

    Export Run Output Options

    Name
    Type
    Description
    location
    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.

    Location

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

    Name
    Type
    Description
    USER_BLOB_STORAGE
    String
    STORAGE
    String

    Error

    Contains error information.

    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, null

    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.

    Name
    Type
    Description
    error
    Error

    Error information.

    Was this page helpful?