Cancel or remove an export
Cancels a queued or running export, or removes a finished one with its file.
Cancel or remove an export
/exports/{id}Cancels a queued or running export, or removes a finished one with its file. status is the export's status when the request arrived.
Cancel or remove
A cancelled export stops, any partial file is removed, and it reads cancelled. A removed one (done, failed, cancelled or expired) is then not found.
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.
Responses
200 OK
Cancelled or removed.
idstringRequiredFormat
uuidExport id.
deletedanyRequiredAlways
trueAlways true.
statusstringRequiredIts status when the request came: queued or running, which this call cancelled; or done, error, cancelled or expired, which it removed.
"queued""running""done""error""cancelled""expired"
Errors
| Status | When |
|---|---|
| 404 | No such well, grid, plan or route. |
Shared errors400401403500503What they mean