Skip to content
Developers
Get an API token

List saved documents

List this tenant documents in one collection, newest updated_at first.

List saved documents

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

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"

Query parameters

  • limitintegerOptional

    Default 50≥ 1, ≤ 100

    Page size, 1-100.

  • cursorstringOptional

    Page to read: next_cursor from the previous page.

  • includestringOptional

    body includes each document body; other or duplicate names are 400.

    "body"
  • plan_idstringOptional

    Format uuid

    Only documents attached to this plan UUID.

Responses

200 OK

Documents and next cursor.

  • itemsarray of objectsRequired

    Newest updated_at first.

    ShowHide 11 child fields in each item
    • idstringRequired

      Format uuid

      Document id.

    • 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.

    • etagstringRequired

      Current ETag including quotes.

    • bodyobjectOptional

      Only with include=body.

    • created_bystring or nullOptional

      plan-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_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.

  • next_cursorstring or nullRequired

    Next page, null at end.

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