Sum a plan's oil, gas and water by pad and zone
One design's oil, gas and water at one ip_day, summed for a plan by pad and by landing zone (formation) in each pad, without downloading the wells.
Sum a plan's oil, gas and water by pad and zone
/plans/{id}/rollupOne design's oil, gas and water at one ip_day, summed for a plan by pad and by landing zone (formation) in each pad, without downloading the wells. Every pad is listed, without paging, as PlanRollup describes; a plan whose wells name no pads answers one key: null pad.
Sums
Wells and streams count as GET /plans/{id} totals counts them: a well counts when its forecast under the design isn't an error, and a stream sums its wells whose stream forecast isn't an error, so a well without a water forecast is left out of water only. A well without a value at ip_day adds 0. Each value is summed unrounded and rounded once to 0.1.
- Counts add up exactly: formations to their pad and pads to
totals,wells_flaggedwith null as 0. - Values can differ from the sum of their parts by rounding: a pad from its N formations by up to 0.05 × (N + 1), and
totalsfrom its P pads by up to 0.05 × (P + 1). - On a done plan the
totalsrow equals GET /plans/{id}totalsfor the same design and scenario wherever those have a value atip_day:wells_with_forecast,wells_flaggedand each stream's value.
EUR
On a plan made with eur: true, every row has eur (PlanRollupEur), rounded and adding up as the values do. It doesn't change with ip_day, so a done plan's totals row has that design and scenario's totals eur, without their P10 and P90 sums.
While it runs
Every pad and formation row is listed from the first read, its counts and sums covering the wells finished so far; partial is true, with Retry-After: 1 and no ETag. A done plan's answer carries an ETag; send If-None-Match for a 304.
Errors
409 for a failed plan; for a plan made with scenarios read without scenario (with details.scenarios), since its rows would add alternatives together; and, with several server tasks, for a plan running on another task until it finishes: retry shortly.
Parameters
Path parameters
idstringRequiredFormat
uuidPlan id from POST /plans.
Query parameters
designintegerOptionalDefault
0≥ 0, ≤ 9The design whose forecasts are summed, as its index in the plan's
designs; 400 past the last one.scenariostringOptionalRequired on a plan made with scenarios, which answers 409 without it: the scenario whose wells are summed, named exactly as the plan's
scenarioslist it, URL-encoded (660 ftisscenario=660%20ft), and echoed.An empty name, or one the plan doesn't have, is a 400 whose
details.scenarioslists the plan's scenarios (empty on a plan without them, where any name is a 400). A name over 60 characters is a 400 without the list.ip_dayintegerOptionalDefault
1080≥ 1The ip_day (days since first production) whose cumulative volumes are summed: one of GET /dataset
ip_days, default 1080 (3 years). Another value is a 400 withdetails.allowed.model_setstringOptionalpattern ^[a-z0-9][a-z0-9-]{0,62}$
The model set to answer from, an
idfrom GET /model-sets. Absent: the set GET /model-sets names asdefault, the base dataset unless the server answers from a published set.model_set=defaultreaches 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 oncedefaultis 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'splan.id, or a comparison'sa.planandb.plan, also undersource.comparison) reaches it withoutmodel_set. - An explicit
model_setwins; naming resources of two sets in one request is a 400.
Responses
200 OK
The roll-up; an ETag when done, Retry-After: 1 while running.
plan_idstringRequiredFormat
uuidPlan id.
designintegerRequired≥ 0
The design, as its index in
designs.scenariostring or nullRequiredThe scenario summed; null on a plan without scenarios.
ip_dayintegerRequired≥ 1
The ip_day (days since first production) each cumulative volume is read at.
partialbooleanRequiredTrue while the plan runs: counts and sums cover the wells finished so far, and every row is listed.
unitsobjectRequiredThe unit of each stream's value.
ShowHide 3 child fields
oilstringRequiredOil volume unit.
"bbl"gasstringRequiredGas volume unit.
"mcf"waterstringRequiredWater volume unit.
"bbl"
totalsobjectRequiredEvery well in scope. On a done plan it equals GET /plans/{id} totals for this design and scenario at ip_day.
ShowHide 7 child fields
wellsintegerRequired≥ 0
Wells in the group and scope, forecast or not, finished or not.
wells_with_forecastintegerRequired≥ 0
Wells with a forecast under the design, as GET /plans/{id} totals counts them; while running, of those finished.
wells_flaggedinteger or nullRequired≥ 0
Wells whose checks flagged inputs outside training, as totals counts them; null when no well in the row was checked.
oilobjectOptionalOne stream's sum.
ShowHide 2 child fields
valuenumber or nullRequiredThe cumulative volume at ip_day summed over
wells, inunits, rounded once to 0.1; null whenwellsis 0.wellsintegerRequired≥ 0
Wells summed: those with this stream's forecast.
gasobjectOptionalOne stream's sum.
Same fields as PlanRollupStream.
waterobjectOptionalOne stream's sum.
Same fields as PlanRollupStream.
eurobjectOptionalOn a plan made with eur: true: each stream's EUR summed over the row's wells with one, and BOE over those with both, by the code GET /plans/{id} totals
euruses; no P10 or P90. Only the streams the model set serves (GET /model-setsstreams): a set serving gas alone answers gas alone.ShowHide 4 child fields
boeobjectRequiredBOE EUR over the wells with both fits, so the sum and the well count agree.
ShowHide 2 child fields
valuenumber or nullRequiredOil EUR plus gas EUR / 6 (bbl of oil equivalent) summed over the wells with both; null when none has.
wellsintegerRequiredWells with both an oil and a gas EUR.
oilobjectOptionalA stream's EUR over the row's wells.
ShowHide 3 child fields
valuenumber or nullRequiredEUR summed over the wells with one; null when none has.
daysinteger or nullRequiredip_day of the EUR; null when none has one, or when the wells summed differ in eur_years: the sum then runs to no one day, and each scenario is read apart.
wellsintegerRequiredWells with an EUR.
gasobjectOptionalA stream's EUR over the row's wells.
Same fields as PlanRollupEurStream.
waterobjectOptionalOnly on a plan made with eur_water: true. BOE doesn't read it.
Same fields as PlanRollupEurStream.
padsarray of objectsRequiredEvery pad, in plan order of each pad's first well, wells without a pad last.
ShowHide 10 child fields in each item
keystring or nullRequiredThe pad key the plan was sent; null for wells without one.
wellsintegerRequired≥ 0
Wells in the group and scope, forecast or not, finished or not.
wells_with_forecastintegerRequired≥ 0
Wells with a forecast under the design, as GET /plans/{id} totals counts them; while running, of those finished.
wells_flaggedinteger or nullRequired≥ 0
Wells whose checks flagged inputs outside training, as totals counts them; null when no well in the row was checked.
formationsarray of objectsRequiredThe pad's wells by formation: GET /formations order, unlisted ones by name, wells without one last.
ShowHide 8 child fields in each item
keystring or nullRequiredThe formation; null for wells without one.
wellsintegerRequired≥ 0
Wells in the group and scope, forecast or not, finished or not.
wells_with_forecastintegerRequired≥ 0
Wells with a forecast under the design, as GET /plans/{id} totals counts them; while running, of those finished.
wells_flaggedinteger or nullRequired≥ 0
Wells whose checks flagged inputs outside training, as totals counts them; null when no well in the row was checked.
oilobjectOptionalOne stream's sum.
Same fields as PlanRollupStream.
gasobjectOptionalOne stream's sum.
Same fields as PlanRollupStream.
waterobjectOptionalOne stream's sum.
Same fields as PlanRollupStream.
eurobjectOptionalOn a plan made with eur: true: each stream's EUR summed over the row's wells with one, and BOE over those with both, by the code GET /plans/{id} totals
euruses; no P10 or P90. Only the streams the model set serves (GET /model-setsstreams): a set serving gas alone answers gas alone.Same fields as PlanRollupEur.
namestringOptionalThe pad's name, only when the plan names it.
oilobjectOptionalOne stream's sum.
Same fields as PlanRollupStream.
gasobjectOptionalOne stream's sum.
Same fields as PlanRollupStream.
waterobjectOptionalOne stream's sum.
Same fields as PlanRollupStream.
eurobjectOptionalOn a plan made with eur: true: each stream's EUR summed over the row's wells with one, and BOE over those with both, by the code GET /plans/{id} totals
euruses; no P10 or P90. Only the streams the model set serves (GET /model-setsstreams): a set serving gas alone answers gas alone.Same fields as PlanRollupEur.
304 Unchanged since the ETag in If-None-Match.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 errors400401403500503What they mean