Read a saved document
Read content and its ETag for editing.
Read a saved document
/saved/{collection}/{id}Read content and its ETag for editing. Unknown collection is 400; unknown, expired-with-plan or other-tenant document is 404; no state store is 409. A private document answers only its creator.
Parameters
Path parameters
collectionstringRequiredSaved 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"idstringRequiredFormat
uuidDocument UUID.
Responses
200 OK
Document.
idstringRequiredFormat
uuidDocument id.
collectionstringRequiredCollection.
"filter-sets""completion-designs""type-curves""views""settings""assumption-sets""column-mappings""plan-views"namestringRequiredName.
visibilitystringRequiredRecorded audience.
"private""tenant"plan_idstring or nullRequiredFormat
uuidAttached plan UUID.
created_atstringRequiredFormat
date-timeCreation time.
updated_atstringRequiredFormat
date-timeLast update.
created_bystring or nullRequiredThe creator's email; null for older documents. A private document with none answers the whole tenant.
etagstringRequiredCurrent ETag including quotes; send as If-Match when replacing.
bodyobjectRequiredSaved JSON content.
versionintegerOptional≥ 1
assumption-sets only: 1 when created, one more on each PUT. POST /plans assumption_set.version names it.
model_setstringOptionalpattern ^[a-z0-9][a-z0-9-]{0,62}$
assumption-sets only: the body's model_set, the model set the set was made on.
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 errors400401403500What they mean