Start Export - Mesh Export

Mesh Export

Download API definition:

This API is a Technical Preview and is available for testing purposes only. Do not use in production.

Start Export

POST https://qa-api.bentley.com/mesh-export/

Start a mesh export from the iModel. Exports are persisted until deleted.

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

StartExport

iModelId

String

Yes

ID of the iModel to extract from.

changesetId

String

Yes

ID of the changeset to extract from. If omitted, export latest.

StartExport exportType

StartExport-exportType

Type of mesh to create, Accepted value are IMODEL, CESIUM and 3DTiles (or 3DTILES). If omitted, defaults to 3DTiles.

Tiler Config

TilerConfigItem[]

A list of key-value pair configuration items forwarded to the tiler executable to customize tile generation behavior.

lastModified

Date-time

Date when job metadata was last modified.

Example

json

{
    "iModelId": "b80f4fc2-4dbb-42c5-bb1f-f5aace3977dc",
    "changesetId": "ed94ed9a0704918d36eeb620219f5e17d8858858",
    "exportType": "3DTiles"
}

Response 202 Accepted

The export was accepted and will be processed

json

{
    "export": {
        "id": "fc3aa1e5-5196-4dd9-a73e-4cfda693e576",
        "displayName": "My iModel",
        "status": "NotStarted",
        "lastModified": "2024-08-22T03:18:43Z",
        "request": {
            "iModelId": "b80f4fc2-4dbb-42c5-bb1f-f5aace3977dc",
            "changesetId": "ed94ed9a0704918d36eeb620219f5e17d8858858",
            "exportType": "3DTiles"
        }
    }
}

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 404 Not Found

Requested iModel is not available.

json

{
    "error": {
        "code": "IModelNotFound",
        "message": "Requested iModel is not available."
    }
}

Response 422 Unprocessable Entity

Cannot create export job.

json

{
    "error": {
        "code": "InvalidMeshExportRequest",
        "message": "Cannot create export job.",
        "details": [{
            "code": "InvalidRequestBody",
            "message": "iModelId cannot be empty.",
            "target": "iModelId"
        }]
    }
}

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

Link

An href link reference.

href

String

Http reference

json

{
    "required": [
        "href"
    ],
    "type": "object",
    "properties": {
        "href": {
            "type": "string",
            "description": "Http reference",
            "example": "https://api.bentley.com/path1/path2/id"
        }
    },
    "additionalProperties": false,
    "description": "An href link reference."
}

StartExport exportType

Type of mesh to create, Accepted value are IMODEL, CESIUM and 3DTiles (or 3DTILES). If omitted, defaults to 3DTiles.

IMODEL

String

CESIUM

String

3DTILES

String

3DTiles

String

json

{
    "enum": [
        "IMODEL",
        "CESIUM",
        "3DTILES",
        "3DTiles"
    ],
    "type": "string",
    "description": "Type of mesh to create, Accepted value are IMODEL, CESIUM and 3DTiles (or 3DTILES). If omitted, defaults to 3DTiles.",
    "title": "StartExport exportType"
}

StartExport

Request body for starting a mesh export.

iModelId

String

ID of the iModel to extract from.

changesetId

String

ID of the changeset to extract from. If omitted, export latest.

StartExport exportType

StartExport-exportType

Type of mesh to create, Accepted value are IMODEL, CESIUM and 3DTiles (or 3DTILES). If omitted, defaults to 3DTiles.

Tiler Config

TilerConfigItem[]

A list of key-value pair configuration items forwarded to the tiler executable to customize tile generation behavior.

lastModified

Date-time

Date when job metadata was last modified.

json

{
    "required": [
        "iModelId",
        "changesetId"
    ],
    "type": "object",
    "properties": {
        "iModelId": {
            "type": "string",
            "description": "ID of the iModel to extract from."
        },
        "changesetId": {
            "type": "string",
            "description": "ID of the changeset to extract from. If omitted, export latest."
        },
        "exportType": {
            "enum": [
                "IMODEL",
                "CESIUM",
                "3DTILES",
                "3DTiles"
            ],
            "type": "string",
            "description": "Type of mesh to create, Accepted value are IMODEL, CESIUM and 3DTiles (or 3DTILES). If omitted, defaults to 3DTiles.",
            "title": "StartExport exportType",
            "$ref": "#/components/schemas/StartExport-exportType"
        },
        "tilerConfig": {
            "title": "Tiler Config",
            "maxItems": 100,
            "minItems": 1,
            "uniqueItems": true,
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/TilerConfigItem"
            },
            "description": "A list of key-value pair configuration items forwarded to the tiler executable to customize tile generation behavior."
        },
        "lastModified": {
            "type": "string",
            "description": "Date when job metadata was last modified.",
            "format": "date-time"
        }
    },
    "additionalProperties": false,
    "description": "Request body for starting a mesh export.",
    "example": {
        "iModelId": "b80f4fc2-4dbb-42c5-bb1f-f5aace3977dc",
        "changesetId": "ed94ed9a0704918d36eeb620219f5e17d8858858",
        "exportType": "3DTiles",
        "tilerConfig": [
            {
                "key": "maxTileSize",
                "value": 128
            },
            {
                "key": "enableCompression",
                "value": true
            },
            {
                "key": "outputFormat",
                "value": "glb"
            }
        ]
    }
}

TilerConfigItem

A key-value configuration item for the tilerConfig.

key

String

Configuration key name.

value

Any of: string number boolean

Configuration value; may be a string, number, or boolean.

json

{
    "required": [
        "key",
        "value"
    ],
    "type": "object",
    "properties": {
        "key": {
            "maxLength": 256,
            "minLength": 1,
            "type": "string",
            "description": "Configuration key name."
        },
        "value": {
            "anyOf": [
                {
                    "maxLength": 1000,
                    "minLength": 1,
                    "type": "string"
                },
                {
                    "type": "number"
                },
                {
                    "type": "boolean"
                }
            ],
            "description": "Configuration value; may be a string, number, or boolean."
        }
    },
    "additionalProperties": false,
    "description": "A key-value configuration item for the tilerConfig."
}

ExportResultBody exportType

Type of mesh exported.

IMODEL

String

CESIUM

String

3DTILES

String

3DTiles

String

json

{
    "enum": [
        "IMODEL",
        "CESIUM",
        "3DTILES",
        "3DTiles"
    ],
    "type": "string",
    "description": "Type of mesh exported.",
    "title": "ExportResultBody exportType"
}

ExportResultBody

The original export request body stored with the result.

iModelId

String

ID of the iModel.

contextId

String

Context/iTwin ID of the export (kept for backwards compatibility).

iTwinId

String

iTwin ID of the export.

changesetId

String

ID of the changeset extracted from.

ExportResultBody exportType

ExportResultBody-exportType

Type of mesh exported.

changesetIndex

String

Index of the changeset.

Tiler Config

TilerConfigItem[]

A list of key value pairs forwarded to the tiler executable.

json

{
    "required": [
        "iModelId",
        "exportType",
        "changesetId"
    ],
    "type": "object",
    "properties": {
        "iModelId": {
            "type": "string",
            "description": "ID of the iModel."
        },
        "contextId": {
            "type": "string",
            "description": "Context/iTwin ID of the export (kept for backwards compatibility)."
        },
        "iTwinId": {
            "type": "string",
            "description": "iTwin ID of the export."
        },
        "changesetId": {
            "type": "string",
            "description": "ID of the changeset extracted from."
        },
        "exportType": {
            "enum": [
                "IMODEL",
                "CESIUM",
                "3DTILES",
                "3DTiles"
            ],
            "type": "string",
            "description": "Type of mesh exported.",
            "title": "ExportResultBody exportType",
            "$ref": "#/components/schemas/ExportResultBody-exportType"
        },
        "changesetIndex": {
            "type": "string",
            "description": "Index of the changeset."
        },
        "tilerConfig": {
            "title": "Tiler Config",
            "maxItems": 100,
            "minItems": 1,
            "uniqueItems": true,
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/TilerConfigItem"
            },
            "description": "A list of key value pairs forwarded to the tiler executable."
        }
    },
    "additionalProperties": false,
    "description": "The original export request body stored with the result."
}

ExportResponse

Response containing the details of a single export.

export

Export

json

{
    "type": "object",
    "properties": {
        "export": {
            "$ref": "#/components/schemas/Export"
        }
    },
    "additionalProperties": false,
    "description": "Response containing the details of a single export.",
    "example": {
        "export": {
            "id": "fc3aa1e5-5196-4dd9-a73e-4cfda693e576",
            "displayName": "My iModel",
            "status": "Complete",
            "lastModified": "2024-08-22T03:18:43Z",
            "request": {
                "iModelId": "b80f4fc2-4dbb-42c5-bb1f-f5aace3977dc",
                "changesetId": "ed94ed9a0704918d36eeb620219f5e17d8858858",
                "exportType": "3DTiles"
            },
            "_links": {
                "mesh": {
                    "href": "https://example.cloudfront.net/mesh-export/fc3aa1e5-5196-4dd9-a73e-4cfda693e576"
                }
            }
        }
    }
}

ExportStatus

Status of the export.

NotStarted

String

InProgress

String

Complete

String

Invalid

String

json

{
    "enum": [
        "NotStarted",
        "InProgress",
        "Complete",
        "Invalid"
    ],
    "type": "string",
    "description": "Status of the export."
}

ExportDirStructure

List of export directory children along with their size, in bytes.

ExportMetrics

Memory and CPU usage metrics from the graphics and tiles producer.

ExportStatsDisplay

Statistics of the export job. This obsoletes the Consumption type.

iModelSize

Number

Size of the iModel .bin file, in bytes

compressedSize

Number

Size of the exported and compressed tiles, in bytes.

rawSize

Number

Size of the exported tiles, in bytes.

startTime

Date-time

Starting date of the export job, pretty-printed.

duration

Number

Duration of the export job, in milliseconds.

diskSize

Number

Disk size, in bytes.

freeDiskSpace

Number

Free disk space, in bytes.

exportDirSize

Number

Export directory size, in bytes.

exportDirStructure

ExportDirStructure

metrics

ExportMetrics

json

{
    "type": "object",
    "properties": {
        "iModelSize": {
            "type": "number",
            "description": "Size of the iModel .bin file, in bytes"
        },
        "compressedSize": {
            "type": "number",
            "description": "Size of the exported and compressed tiles, in bytes."
        },
        "rawSize": {
            "type": "number",
            "description": "Size of the exported tiles, in bytes."
        },
        "startTime": {
            "type": "string",
            "description": "Starting date of the export job, pretty-printed.",
            "format": "date-time"
        },
        "duration": {
            "type": "number",
            "description": "Duration of the export job, in milliseconds."
        },
        "diskSize": {
            "type": "number",
            "description": " Disk size, in bytes."
        },
        "freeDiskSpace": {
            "type": "number",
            "description": "Free disk space, in bytes."
        },
        "exportDirSize": {
            "type": "number",
            "description": "Export directory size, in bytes."
        },
        "exportDirStructure": {
            "$ref": "#/components/schemas/ExportDirStructure"
        },
        "metrics": {
            "$ref": "#/components/schemas/ExportMetrics"
        }
    },
    "additionalProperties": false,
    "description": "Statistics of the export job. This obsoletes the Consumption type."
}

Export

An export with all its details.

String

ID of the export request.

displayName

String

Name of the exported iModel

status

ExportStatus

lastModified

String

Date when job metadata was last modified

request

ExportResultBody

stats

ExportStatsDisplay

error

String

Error message for Invalid exports.

_links.mesh

Link

json

{
    "required": [
        "id",
        "displayName",
        "status",
        "lastModified",
        "request"
    ],
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "ID of the export request."
        },
        "displayName": {
            "type": "string",
            "description": "Name of the exported iModel"
        },
        "status": {
            "$ref": "#/components/schemas/ExportStatus"
        },
        "lastModified": {
            "type": "string",
            "description": "Date when job metadata was last modified"
        },
        "request": {
            "$ref": "#/components/schemas/ExportResultBody"
        },
        "stats": {
            "$ref": "#/components/schemas/ExportStatsDisplay"
        },
        "error": {
            "type": "string",
            "description": "Error message for Invalid exports."
        },
        "_links": {
            "type": "object",
            "properties": {
                "mesh": {
                    "$ref": "#/components/schemas/Link"
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": false,
    "description": "An export with all its details.",
    "example": {
        "id": "fc3aa1e5-5196-4dd9-a73e-4cfda693e576",
        "displayName": "My iModel",
        "status": "Complete",
        "request": {
            "iModelId": "b80f4fc2-4dbb-42c5-bb1f-f5aace3977dc",
            "changesetId": "ed94ed9a0704918d36eeb620219f5e17d8858858",
            "exportType": "3DTiles"
        },
        "_links": {
            "mesh": {
                "href": "https://example.cloudfront.net/mesh-export/fc3aa1e5-5196-4dd9-a73e-4cfda693e576"
            }
        }
    }
}

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

{
    "required": [
        "code",
        "message"
    ],
    "type": "object",
    "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
        }
    },
    "description": "Contains error information."
}

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

json

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

Was this page helpful?