List saved documents
List this tenant documents in one collection, newest updated_at first.
List saved documents
/saved/{collection}List this tenant documents in one collection, newest updated_at first. Use include=body to read content too, and plan_id to find a plan draft. A private document answers only its creator. Unknown collection or include, invalid plan_id, limit or cursor is 400; an unserved tenant is 404; no state store is 409.
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"
Query parameters
limitintegerOptionalDefault
50≥ 1, ≤ 100Page size, 1-100.
cursorstringOptionalPage to read:
next_cursorfrom the previous page.includestringOptionalbody includes each document body; other or duplicate names are 400.
"body"plan_idstringOptionalFormat
uuidOnly documents attached to this plan UUID.
Responses
200 OK
Documents and next cursor.
itemsarray of objectsRequiredNewest updated_at first.
ShowHide 11 child fields in each item
idstringRequiredFormat
uuidDocument id.
namestringRequiredName.
visibilitystringRequiredRecorded audience.
"private""tenant"plan_idstring or nullRequiredFormat
uuidAttached plan UUID.
created_atstringRequiredFormat
date-timeCreation time.
updated_atstringRequiredFormat
date-timeLast update.
etagstringRequiredCurrent ETag including quotes.
bodyobjectOptionalOnly with include=body.
created_bystring or nullOptionalplan-views only: the creator's email; null for a view saved without a signed-in user.
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.
next_cursorstring or nullRequiredNext page, null at end.
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