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.

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

Start a mesh export from the iModel. The exports will remain available until they are deleted.

Deprecation

Recently, the iTwin platform incorporated the ability to auto-generate 3D Tiles when iModels change. Therefore, it is no longer necessary to manually generate the tiles, as the platform will handle it.

In the future, all tiles will be generated automatically, and the ability to generate them manually will be deprecated.

Therefore, we advise against using this functionality or deprecating it as soon as possible if you are currently using it.

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 headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Request body

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 3DFT, CESIUM, IMODEL and 3DTiles

lastModified

Date-time

Date when job metadata was last modified

Example

json

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

Response

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",
            "lastModified": "2024-08-22T03:18:43Z"
        }
    }
}

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

The user has insufficient permissions for the requested operation.

json

{
    "error": {
        "code": "InsufficientPermissions",
        "message": "The user has insufficient permissions for the requested operation."
    }
}

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

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
}

ExportResponse

export

Export

json

{
    "type": "object",
    "properties": {
        "export": {
            "$ref": "#/components/schemas/Export"
        }
    },
    "additionalProperties": false,
    "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://azure.net/blob/fc3aa1e5-5196-4dd9-a73e-4cfda693e576?saskey"
                }
            }
        }
    }
}

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."
}

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.

metrics

Object

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."
        },
        "metrics": {
            "type": "object",
            "additionalProperties": false
        }
    },
    "additionalProperties": false,
    "description": "Statistics of the export job. This obsoletes the Consumption type."
}

Export

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

StartExport

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/StartExport"
        },
        "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,
    "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://azure.net/blob/fc3aa1e5-5196-4dd9-a73e-4cfda693e576?saskey"
            }
        }
    }
}

StartExport exportType

Type of mesh to create, Accepted value are 3DFT, CESIUM, IMODEL and 3DTiles

3DFT

String

IMODEL

String

CESIUM

String

3DTiles

String

json

{
    "enum": [
        "3DFT",
        "IMODEL",
        "CESIUM",
        "3DTiles"
    ],
    "type": "string",
    "description": "Type of mesh to create, Accepted value are 3DFT, CESIUM, IMODEL and 3DTiles",
    "title": "StartExport exportType"
}

StartExport

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 3DFT, CESIUM, IMODEL and 3DTiles

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": [
                "3DFT",
                "IMODEL",
                "CESIUM",
                "3DTiles"
            ],
            "type": "string",
            "description": "Type of mesh to create, Accepted value are 3DFT, CESIUM, IMODEL and 3DTiles",
            "title": "StartExport exportType",
            "$ref": "#/components/schemas/StartExport-exportType"
        },
        "lastModified": {
            "type": "string",
            "format": "date-time",
            "description": "Date when job metadata was last modified"
        }
    },
    "additionalProperties": false,
    "example": {
        "iModelId": "b80f4fc2-4dbb-42c5-bb1f-f5aace3977dc",
        "changesetId": "ed94ed9a0704918d36eeb620219f5e17d8858858",
        "exportType": "3DTiles"
    }
}

DetailedError

Contains error information and an array of more specific errors.

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.

details

Error[]

Optional array of more specific errors.

json

{
    "type": "object",
    "description": "Contains error information and an array of more specific errors.",
    "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
        },
        "details": {
            "type": "array",
            "description": "Optional array of more specific errors.",
            "items": {
                "$ref": "#/components/schemas/Error"
            }
        }
    },
    "required": [
        "code",
        "message",
        "details"
    ],
    "additionalProperties": true
}

Detailed 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

DetailedError

Error Detailed information.

json

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

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

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?