Link

href

string

ExportListLinks

self

ViewDefinitionFilter

models

neverDrawn

GeometryOptions

Control whether linework is exported. If omitted, linework is included.

includeLines

boolean

Max distance from a face to the original geometry.

chordTol

number

Max angle difference in radians for approximated face.

angleTol

Max distance between mesh vertices for them to be collapsed.

decimationTol

Max length of any edge in generated faces.

maxEdgeLength

BRep features with bounding boxes smaller than this size will not generate graphics.

minBRepFeatureSize

The longest dimension of a line style's largest component must be at least this size.

minLineStyleComponentSize

PostRequest

PostRequest-1

GetRequest

GetRequest-1

id-GetRequest

id-GetRequest-1

id-GetRequest-2

ExportResponse

export

Export

ExportListRepresentationResponse

exports

_links

ExportMinimal

displayName

status

ExportStatus

NotStarted

InProgress

Complete

Invalid

request

StartExport

URL where the result of the export is stored.

_links.mesh

ExportListMinimalResponse

Requested export list minimal representation.

iModelId

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

changesetId

Type of mesh to create. Currently, only GLTF and 3DFT are supported.

exportType

[ExportGraphicsOptions](https://www.itwinjs.org/reference/core-backend/imodels/exportgraphicsoptions/). If omitted, use defaults from ExportGraphicsOptions.

geometryOptions

View filtering options to limit the scope of the export.

viewDefinitionFilter

Contains error information and an optional array of more specific errors.

Error

One of a server-defined set of error codes.

code

A human-readable representation of the error.

message

target

details

ErrorDetails

Error Details

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.

ErrorResponse

error

Error Response

mesh-export

---

Deletes an export that is completed or invalid.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `mesh-export:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


delete-export

OAuth access token with scope `mesh-export:modify`

Authorization

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

Accept

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.

HeaderNotFound

application/json;InvalidAuthorizationScheme

InvalidAuthorizationScheme

InvalidHeaderValue

RequiredScopeMissing

Unauthorized

default

Invalid or inexistent Id. Also occurs on exports that are in progress.

This response indicates that the user has sent too many requests in a given amount of time.

The number of requests exceeds the rate-limit for the client subscription.

retry-after

---

Retrieves the information for a single export. Exports are persisted until deleted.

When a mesh export succeeds, the `_links.mesh` returns a URL to download the resulting mesh from the blob container. You can list the contents of the container by appending the query parameters `restype=container&comp=list` to the URL. Note: Anyone with this URL has access to download the resultant mesh, share with care. The link is valid for one hour.

### GLTF Meshes

Exporting `GLTF` meshes produces two files: `Export.gltf` and `Export.bin`. To download these files you must split the URL provided in `_links.mesh.href` and append the file name to the URL before the query parameters. For example:
`SASUrl/Export.gltf?SASKey` and `SASURL/Export.bin?SASKey`. Use these URLs to download the relevant files. Note: The files will always be named `Export.gltf` and `Export.bin`.

### 3DFT Meshes

When exporting `3DFT` meshes, feed the URL to the [Unreal Engine Plugin](https://itwin-3dft.netlify.app/) to stream the mesh in Unreal.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `mesh-export:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


get-export

OAuth access token with scope `mesh-export:read`

---

Returns a list of all exports previously requested by the user that have not expired and their statuses.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `mesh-export:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


get-exports

The [$top](https://www.odata.org/getting-started/basic-tutorial/#topskip) system query option requests the number of items in the queried collection to be included in the result.

$top

The [$skip](https://www.odata.org/getting-started/basic-tutorial/#topskip) query option requests the number of items in the queried collection that are to be skipped and not included in the result.

$skip

The iModelId query parameter allows you to filter exports by a given iModel Id.

The changesetId query parameter allows you to filter exports by a given changeset Id.

Indicates a level of details in the response. Valid values are 'return=representation' or 'return=minimal'. The default is 'return=minimal'.

Prefer

minimal

representation

---

Start a mesh export from the iModel. Exports are persisted until deleted.

When a mesh export succeeds, the `_links.mesh` returns a URL to download the resulting mesh from the blob container. You can list the contents of the container by appending the query parameters `restype=container&comp=list` to the URL. Note: Anyone with this URL has access to download the resultant mesh, share with care. The link is valid for one hour.

### GLTF Meshes

Exporting `GLTF` meshes produces two files: `Export.gltf` and `Export.bin`. To download these files you must split the URL provided in `_links.mesh.href` and append the file name to the URL before the query parameters. For example:
`SASUrl/Export.gltf?SASKey` and `SASURL/Export.bin?SASKey`. Use these URLs to download the relevant files. Note: The files will always be named `Export.gltf` and `Export.bin`.

### 3DFT Meshes

When exporting `3DFT` meshes, feed the URL to the [Unreal Engine Plugin](https://itwin-3dft.netlify.app/) to stream the mesh in Unreal.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `mesh-export:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


start-export

The export was accepted and will be processed

The user has insufficient permissions for the requested operation.

API references