Get Exports - Mesh Export | iTwin Platform

Mesh Export

Download API definition:

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

GET https://qa-api.bentley.com/mesh-export/[?iModelId][&changesetId][&$top][&$skip][&$orderBy][&cdn][&tileVersion][&exportType][&iTwinJS]

Returns a list of all exports previously requested by the user that have not expired and their statuses.

Request parameters

iModelId

Optional iModel Id query parameter. Will return all exports contained in the iModel as long as user has access to it.

changesetId

Optional Changeset Id query parameter. Will return all exports that have the matching changeset Id.

$top

The $top system query option requests the number of items in the queried collection to be included in the result.

$skip

The $skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.

$orderBy

The $orderBy query parameter allows you to order by exports' last modified date. At the moment, only $orderBy=date:asc and $orderBy=date:desc is supported.

cdn

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

tileVersion

Optional tileVersion query parameter. Will return all exports compatible with that tileVersion.

exportType

Optional exportType query parameter. Will return all exports that have the matching exportType.

iTwinJS

Optional iTwinJS query parameter. Will return all exports compatible with that iTwinJS version.

Request headers

prefer

This operation supports return=representation and return=minimal preferences, defaults to return=minimal if not provided.

x-api-host-and-root

Prefix to add to list links.

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Response 200 OK

List of user requested exports.

json

{
    "exports": [{
        "id": "fc3aa1e5-5196-4dd9-a73e-4cfda693e576",
        "displayName": "My iModel",
        "status": "NotStarted",
        "lastModified": "2024-08-22T03:18:43Z"
    }, {
        "id": "57ea169d-144a-4219-b530-9ce360fd194f",
        "displayName": "My previous iModel",
        "status": "Complete",
        "lastModified": "2024-08-22T03:18:43Z"
    }, {
        "id": "4777e39e-03a7-48b1-a5c1-4018beaefb25",
        "displayName": "Invalid",
        "status": "Invalid",
        "lastModified": "2024-08-22T03:18:43Z"
    }],
    "_links": {
        "self": {
            "href": "https://api.bentley.com/mesh-export/?$top=100&$skip=0"
        },
        "next": {
            "href": "https://api.bentley.com/mesh-export/?$top=100&$skip=100"
        }
    }
}

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 422 Unprocessable Entity

Cannot retrieve export.

json

{
    "error": {
        "code": "InvalidMeshExportRequest",
        "message": "Cannot retrieve export.",
        "details": [{
            "code": "InvalidParameter",
            "message": "$top must be lower or equal to 1000.",
            "target": "$top"
        }, {
            "code": "InvalidParameter",
            "message": "iModelId is invalid.",
            "target": "iModelId"
        }, {
            "code": "InvalidParameter",
            "message": "changesetId is invalid.",
            "target": "changesetId"
        }]
    }
}

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

ExportListResponse

Response containing a list of exports, either in full representation or minimal form depending on the prefer header.

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?