Skip to content
Developers
Get an API token

Delete a saved document

Delete a document from the request tenant.

Delete a saved document

DELETE/saved/{collection}/{id}

Delete a document from the request tenant. Unknown collection is 400; unknown or other-tenant document is 404; no state store is 409. If-Match is optional: a stale one is a 409 conflict with details.etag set to the current ETag, and nothing is deleted; without it, the document is deleted whatever its ETag.

Send a Novi API token as a bearer token on every request. Authentication

Parameters

Path parameters

  • collectionstringRequired

    Saved document collection; any other name is 400. assumption-sets takes a typed body, AssumptionSetBody; column-mappings takes { column_hints, formations? }. plan-views takes a PlanViewBody, checked as GET /plans checks its parameters.

    "filter-sets""completion-designs""type-curves""views""settings""assumption-sets""column-mappings""plan-views"
  • idstringRequired

    Format uuid

    Document UUID.

Header parameters

  • If-MatchstringOptional

    The document's current etag, including quotes. Absent: deleted without the check.

Responses

204 No Content

Deleted.

Errors

StatusWhen
404

No such well, grid, plan or route.

409

The request conflicts with the state of the plan or resource it names, and message says how: for example a plan still running or failed, a stale If-Match, an Idempotency-Key reused with another body, or a server without a state store.

Shared errors400401403500What they mean