Get Export - Mesh Export | iTwin Platform

REST API Overview

Overview

Samples

Reference

Changelog

Mesh Export

Download API definition:

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

Get Export

GET https://api.bentley.com/mesh-export/{id}[?cdn]

Retrieves the information for a single export using its exportId.

Important: Although this method has not been officially deprecated yet, get-exports is the recommended method to obtain the list of exports and access to the tiles.

We strongly recommend discontinuing the use of get-export, as we will remove it during the transition from Tech Preview to General Availability.

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

Yes

Export Id to get the results

cdn

Optional cdn query parameter. Will return cdn based urls if set to 1.

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Response 200 OK

Specified export

json

{
    "export": {
        "id": "fc3aa1e5-5196-4dd9-a73e-4cfda693e576",
        "displayName": "My previous iModel",
        "status": "Complete",
        "lastModified": "2024-08-22T03:18:43Z",
        "request": {
            "iModelId": "b80f4fc2-4dbb-42c5-bb1f-f5aace3977dc",
            "changesetId": "ed94ed9a0704918d36eeb620219f5e17d8858858",
            "exportType": "3DTiles",
            "lastModified": "2024-08-22T03:18:43Z"
        },
        "_links": {
            "mesh": {
                "href": "https://example.cloudfront.net/{bucket}?parameters"
            }
        }
    }
}

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 export is not available.

json

{
    "error": {
        "code": "ExportNotFound",
        "message": "Requested export is not available."
    }
}

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

ExportResponse

export

Export

ExportStatus

Status of the export.

NotStarted

String

InProgress

String

Complete

String

Invalid

String

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

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

StartExport exportType

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

3DFT

String

IMODEL

String

CESIUM

String

3DTiles

String

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

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.

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.

Was this page helpful?