Skip to content
Developers
Get an API token

Export a plan

The plan as a zip of six CSVs, built while you wait and stored uncompressed with its length, so clients can show progress.

Export a plan

GET/plans/{id}/export

The plan as a zip of six CSVs, built while you wait and stored uncompressed with its length, so clients can show progress. New clients should use POST /exports: its plan_tables preset writes the same CSVs as a job, with monthly volumes to EUR and a file that resumes.

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

The six CSVs:

  • wells.csv: inputs, TVD, heel and pad, plus each well's values and their layers for completions, TIL dates, landings and EUR settings set below the plan (water's with eur_water).
  • designs.csv: each design's completions and their source.
  • forecast.csv: cumulative oil, gas and water per well by design and ip_day, plus each design's plan total.
  • neighbors.csv, calc_features.csv and subsurface.csv.
Errors

409 while the plan runs or when it failed, and for two kinds of plan, which POST /exports with "source": {"plan": "<id>"} takes:

  • A plan made with scenarios, whose Plan total rows would add its alternatives together: send scenario, one export per scenario.
  • A plan of more than 10,000 forecasts (wells × designs), too big for one answer. Made with scenarios, it also sends scenario; the 409's details.scenarios says how many.

Parameters

Path parameters

Query parameters

  • model_setstringOptional

    pattern ^[a-z0-9][a-z0-9-]{0,62}$

    The model set to answer from, an id from GET /model-sets. Absent: the set GET /model-sets names as default, the base dataset unless the server answers from a published set.

    • model_set=default reaches the base dataset; once the server retires it, a 400 naming the set answering instead.
    • An unknown id, or a set scoped to other tenants, is a 400 listing the ids the caller may use in details.allowed (published sets only once default is retired); a set that can't load, a 503 with the reason.
    • Plans and exports stay in their set: a call naming them (by path, plan, ids, source.plan, a scenario's plan.id, or a comparison's a.plan and b.plan, also under source.comparison) reaches it without model_set.
    • An explicit model_set wins; naming resources of two sets in one request is a 400.

Responses

200 OK

The zip.

Returns application/zip.

Errors

StatusWhen
404

No such well, grid, plan or route.

409

The plan is running or failed; it was made with scenarios, whose Plan total rows would add its alternatives together; or it has more than 10,000 forecasts, wells × designs. Export the last two with POST /exports. A plan over the cap that was made with scenarios takes scenario too, one export per scenario, and details.scenarios says how many it has.

Shared errors400401403500503What they mean