Retrieves a list of all 3D Tiles generation tasks, each with its current status (not started, in-progress, completed, or failed).
To obtain the URL for the tiles so that the 3D viewer can stream them, you can use the prefer
header with the value return=representation
. This will include a URL for the viewer to access the tiles.
When a mesh export succeeds, the _links.mesh
returns a URL to stream the resulting tiles from the blob container.
You can list the contents of the container by appending the query parameters restype=container&comp=list
to the URL.
The link is valid for one hour.
Streaming 3DTiles
Exporting 3DTiles
always produces a JSON file tileset.json
, that contains the description and structure of the tileset, and many 3D tile files in GLB format (GLTF binary).
3D viewers require a URL to the tileset.json
file to start streaming the tiles.
To generate this URL you must:
- Split the URL provided in
_links.mesh.href
in two parts: the URL base and the query parameters. - Append the file name
tileset.json
to the base URL. - Append the query parameters to the resulting previous URL.
For example: {baseUrl}/tileset.json?{SASKey}
Selecting the latest version
To obtain the latest version, you do not need to define the changesetId
.
This will return the list of exports ordered by changesetIndex
, with the newest first.
To filter the exports, we recommend using &exportType=3DTiles
.
This will also help the system improve auto-generation, as it will allow the service to know the type of export we want to use.
Auto-generation
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.
Sometimes, the generation of tiles may be starting. If the call to get-exports does not return any export, we recommend trying again after a few seconds (10s-30s).
Important: The first generation of 3D tiles for an iModel may be slower, but subsequent automatic generations will be faster, so we recommend keeping this in mind and informing the user.
SASKey
When accessing 3D Tiles, the provided URL includes a Shared Access Signature (SAS) key, which grants secure, temporary access to each file within the container. The SAS key is embedded in the URL, allowing direct access to the files without requiring further authentication. Ensure that the URL retains its SAS key, as it controls access permissions and is necessary to retrieve the files in the container.
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.
Was this page helpful?