Skip to content
Developers
Get an API token

Read a saved document

Read content and its ETag for editing.

Read a saved document

GET/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.

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.

Responses

200 OK

Document.

  • idstringRequired

    Format uuid

    Document id.

  • collectionstringRequired

    Collection.

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

    Name.

  • visibilitystringRequired

    Recorded audience.

    "private""tenant"
  • plan_idstring or nullRequired

    Format uuid

    Attached plan UUID.

  • created_atstringRequired

    Format date-time

    Creation time.

  • updated_atstringRequired

    Format date-time

    Last update.

  • created_bystring or nullRequired

    The creator's email; null for older documents. A private document with none answers the whole tenant.

  • etagstringRequired

    Current ETag including quotes; send as If-Match when replacing.

  • bodyobjectRequired

    Saved JSON content.

  • versionintegerOptional

    ≥ 1

    assumption-sets only: 1 when created, one more on each PUT. POST /plans assumption_set.version names it.

  • model_setstringOptional

    pattern ^[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

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