Revoke a plan share
Disable a share immediately.
Revoke a plan share
/plans/{id}/shares/{share_id}Disable a share immediately. Revoking it again also returns 204. An unknown plan or share, or another tenant, is 404. No state store or repeated concurrent changes is 409; retry a concurrent change.
Parameters
Path parameters
idstringRequiredFormat
uuidPlan id from POST /plans.
share_idstringRequiredFormat
uuidShare id from createPlanShare or listPlanShares.
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
204 No Content
Revoked, including an already revoked share.
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