Download an export's zip
A done export's zip, streamed with its Content-Length, a strong ETag and Accept-Ranges: bytes, so a download can resume.
Download an export's zip
/exports/{id}/fileA done export's zip, streamed with its Content-Length, a strong ETag and Accept-Ranges: bytes, so a download can resume. HEAD answers the same headers without the body.
Ranges
Range: bytes=a-b, a- or -n (the last n bytes) answers 206 with Content-Range; a range starting past the end is 416, and several ranges get the whole file. If-Range sends the range only for this ETag, else the whole file. If-None-Match with the ETag answers 304.
Another task's file
GET answers a file another server task wrote with a 307 to a copy in the server's file store, signed for 15 minutes, which takes Range and has its own ETag: follow it without this API's credentials. HEAD and If-None-Match still answer here.
Errors
409 until the export is done (or when it failed or was cancelled), 410 once it expired.
Tenant
Exports belong to the request's tenant: lists hold only its exports, and another tenant's export is a 404 to read, download or delete. A signed-in user's tenant is their customer; a configured user's, the server's default tenant.
Parameters
Path parameters
idstringRequiredFormat
uuidExport id from POST /exports.
Query parameters
model_setstringOptionalpattern ^[a-z0-9][a-z0-9-]{0,62}$
The model set to answer from, an
idfrom GET /model-sets. Absent: the set GET /model-sets names asdefault, the base dataset unless the server answers from a published set.model_set=defaultreaches the base dataset; once the server retires it, a 400 naming the set answering instead.- An unknown id, or a set scoped to other tenants, is a 400 listing the ids the caller may use in
details.allowed(published sets only oncedefaultis retired); a set that can't load, a 503 with the reason. - Plans and exports stay in their set: a call naming them (by path,
plan,ids,source.plan, a scenario'splan.id, or a comparison'sa.planandb.plan, also undersource.comparison) reaches it withoutmodel_set. - An explicit
model_setwins; naming resources of two sets in one request is a 400.
Header parameters
RangestringOptionalOne byte range, as bytes=0-1048575, bytes=1048576- or bytes=-1024.
If-RangestringOptionalThe ETag of the copy you have part of: the range is sent only if the file is still that one.
Responses
The zip.
Returns application/zip.
The requested bytes of the zip.
Returns application/zip.
Another server task wrote the file: download it from Location.
The OpenAPI document has no schema for this response.
304 Unchanged since the ETag in If-None-Match.Errors
| Status | When |
|---|---|
| 404 | No such well, grid, plan or route. |
| 409 | The export isn't done yet, or it failed or was cancelled, so it has no file. |
| 410 | The export expired, and its file was removed; create the export again. |
| 416 | The range starts past the end of the file. |
Shared errors400401403500503What they mean