Delete a plan
Deletes a plan: revokes its shares, deletes its attached saved documents, then drops the plan and its results.
Delete a plan
/plans/{id}Deletes a plan: revokes its shares, deletes its attached saved documents, then drops the plan and its results. A running plan stops after its chunks in flight. It doesn't wait for a restarted server to finish reading its stored plans.
Exports
Exports of the plan aren't cancelled: each keeps the plan until its file is written, and the file stays until it expires.
Errors
- 409 with
details.savedanddetails.shares:unless=savedon a saved or shared plan. - 409, which can be retried: a plan running on another server, or one that keeps changing while it is deleted.
- 409
conflictwithdetails.reasonplan_read_only: a Legacy Forecast (origin.enginefe), which is never deleted.
Parameters
Path parameters
idstringRequiredFormat
uuidPlan id from POST /plans.
Query parameters
unlessstringOptionalsaved: delete the plan only if it isn't saved and has no active share link; otherwise answer 409conflictwithdetails{id, saved, shares}and leave the plan, its shares and its documents as they were.sharescounts active share links; no other 409 here carriessaved. Use it to drop a plan you believe is unsaved without losing a save or share made meanwhile, as from another tab: the plan is marked deleting only if its metadata hasn't changed since the check, so a save or share that lands first wins. Without a state store no plan is saved, so it deletes as without it. Another value, an empty one orunlesstwice is a 400."saved"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
Deleted.
idstringRequiredFormat
uuidPlan id.
deletedanyRequiredAlways
trueAlways true.
Errors
| Status | When |
|---|---|
| 404 | No such well, grid, plan or route. |
| 409 | The request conflicts with the state of the plan or resource it names, and |
Shared errors400401403500503What they mean