Read pads and their wells from a file of pad outlines
Pads from a file of pad outlines, each with the wells POST /layouts/fill lays in it, named by its pad and ready for POST /plans.
Read pads and their wells from a file of pad outlines
/pads/readPads from a file of pad outlines, each with the wells POST /layouts/fill lays in it, named by its pad and ready for POST /plans. Nothing is stored: send the file again to read it again.
Upload
The file is read as POST /areas reads it, sent as multipart/form-data (curl -F file=@pads.zip -F formation="WOLFCAMP A" <origin>/api/v1/pads/read) or in a JSON body, and the naming, crs, fields, skipped and warnings come as POST /areas gives them, without its warning on holes or several parts. Each polygon is a pad; points and lines are in skipped, with a warning when there are points.
The wells
wells and pad_values post as they are to POST /plans: {"wells": wells, "pads": pad_values}. A pad's pad_values entry holds those of these the file gives (with none, it changes nothing in the plan); a value that doesn't read is dropped with an issue, keeping the pad:
- TIL date, read as POST /inventories/read reads one, from GET /dataset
as_ofto 30 years from today; - fluid and proppant per ft, over 0 and under 1,000 bbl/ft and 20,000 lb/ft;
- the stage inputs: stage length over 0 and under 2,000 ft, clusters per stage over 0 and under 100, frac rate over 0 and under 500 bbl/min;
- TVD (over 0 and under 40,000 ft) or landing fraction (0 at the formation top to 1 at its base); with both, the TVD is kept, with an issue.
Columns
Each role reads the first of its names the file has, found as POST /inventories/read finds them, or the field columns names (exactly, else in any case; an unknown role or field is a 400):
formation: noviformation, targetformation, formation, targetzone, landingzone, zonetil_date: novitildate, tildate, tillateral_length_ft: novilaterallength, laterallength, laterallentvd_ft: novitvd, tvd, tvdftfluid_bbl_per_ft: novicalcfluidperlength, fluidbblperft, fluidperft, fluidperlengthproppant_lb_per_ft: novicalcproppantperlength, proppantlbperft, proppantperft, proppantperlength, propperftwells_per_section: wellspersection, wpsspacing_ft: spacingft, lateralspacing, spacingazimuth_deg: azimuthdeg, azimuth, azisetback_ft: setbackft, setbacklanding_fraction: landingfractionstage_length_ft: novistagelength, novicalcstagespacing, stagelengthft, stagelength, stagespacing, stagespacingft, stagelenclusters_per_stage: noviclustersperstage, novicalcclustersperstage, clustersperstage, cluststgfrac_rate_bbl_per_min: novifracrate, fracratebblpermin, fracrate, fracratebblmin, fracratebpm, fracbpm
A warning names filled stage fields the model set's models don't read, and a role field missing from a pad that carries POST /areas' 50 properties.
Laying out
Each pad lays its wells as POST /layouts/fill does, in its outline, or its whole area when it has holes or several parts. It takes its azimuth_deg (else the outline's long axis), lateral_length_ft (else edge to edge), setback_ft (else 0) and one bench: its formation (any case; a blank one takes the request's) at its wells_per_section (1 to 52, whole), else a spacing_ft that is 5,280 ft over such a number (within 1e-6), else the request's wells_per_section (default 6).
A value out of range (an azimuth outside -360 to 360, a lateral length outside 1,000 to 30,000 ft, a setback outside 0 to 2,640 ft, a spacing that isn't such a number, with the nearest one named) is dropped with an issue, and the pad takes the fallback.
Left out
A pad left out has left_out: true, no wells and the reason last in issues:
- a name over 60 characters, or one a pad kept before it has;
- an outline that can't be filled, or outside the dataset (GET /dataset bbox);
- a blank formation without the request's, or a formation the dataset lacks (counted in
unknown_formations); - holes too detailed to check in one request (send fewer or simpler pads);
- a fill POST /layouts/fill would refuse (its message), or no well laid.
Limits
POST /areas' limits; GET /dataset limits.plan_wells wells in all; and 35,000,000 of fill work in all (35 times one POST /layouts/fill's), counting each pad that reaches its fill. Past one, a 400 on the file's field with details.max and details.count (polygons, wells) or details.max_work and details.work. Pads are laid in file order, and for the wells details.count is the wells laid up to the pad that passed the limit.
Errors
400 with details.field naming the input, as POST /areas' are, and columns.<role> (with details.fields for a field the file lacks), formation or wells_per_section. A body over 10 MB is a 413.
Parameters
Query parameters
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.
Request body
The file: uploaded as multipart/form-data, or in a JSON body for clients limited to JSON.
filestringRequiredFile
The zipped shapefile (.zip), GeoJSON, KML or KMZ file, as a file part, as POST /areas takes it.
crsstringOptionalAs crs in the JSON body: an EPSG code.
name_fieldstringOptionalAs name_field in the JSON body.
name_fieldsstringOptionalAs name_fields in the JSON body, as JSON text.
name_separatorstringOptionalAs name_separator in the JSON body.
formationstringOptionalAs formation in the JSON body.
columnsstringOptionalAs columns in the JSON body, as JSON text: {"formation": "Zone"}.
wells_per_sectionstringOptionalAs wells_per_section in the JSON body, as JSON text: 6.
shapefilestringOptionalAs POST /areas takes it: a zipped shapefile in base64. Where you can, upload the file itself as multipart/form-data instead.
geojsonobjectOptionalAs POST /areas takes it: a GeoJSON FeatureCollection, Feature, Polygon or MultiPolygon of pad outlines.
kmlstringOptionalAs POST /areas takes it: a KML file's text.
kmzstringOptionalAs POST /areas takes it: a KMZ in base64. Where you can, upload the file itself as multipart/form-data instead.
crsstring or integer or nullOptionalAs POST /areas takes it: the file's coordinate system as an EPSG code.
name_fieldstring or nullOptionalup to 100 characters
As POST /areas takes it: the field (any case) whose value names each pad.
name_fieldsarray of strings or nullOptional1 to 5 itemsItems 1 to 100 characters
As POST /areas takes it: fields whose values, joined, name each pad.
name_separatorstring or nullOptionalup to 8 characters
As POST /areas takes it.
columnsobjectOptionalFields to read a role from instead of the one found by name: the exact field name, else in any case. A field the file lacks is a 400 with details.fields.
ShowHide 14 child fields
formationstring or nullOptionalThe field of each pad's formation.
til_datestring or nullOptionalThe field of each pad's til_date.
lateral_length_ftstring or nullOptionalThe field of each pad's lateral_length_ft.
tvd_ftstring or nullOptionalThe field of each pad's tvd_ft.
fluid_bbl_per_ftstring or nullOptionalThe field of each pad's fluid_bbl_per_ft.
proppant_lb_per_ftstring or nullOptionalThe field of each pad's proppant_lb_per_ft.
wells_per_sectionstring or nullOptionalThe field of each pad's wells_per_section.
spacing_ftstring or nullOptionalThe field of each pad's spacing_ft.
azimuth_degstring or nullOptionalThe field of each pad's azimuth_deg.
setback_ftstring or nullOptionalThe field of each pad's setback_ft.
landing_fractionstring or nullOptionalThe field of each pad's landing_fraction.
stage_length_ftstring or nullOptionalThe field of each pad's stage_length_ft.
clusters_per_stagestring or nullOptionalThe field of each pad's clusters_per_stage.
frac_rate_bbl_per_minstring or nullOptionalThe field of each pad's frac_rate_bbl_per_min.
formationstring or nullOptionalThe formation of pads whose formation is blank, or of every pad when the file has no formation field (any case; GET /formations lists them).
wells_per_sectioninteger or nullOptional≥ 1, ≤ 52
Wells per section for pads without their own (or a spacing that gives one); default 6.
Responses
200 OK
The pads in file order, and their wells.
countintegerRequired≥ 0
Pads kept: those not left out.
wells_countintegerRequired≥ 0
Wells laid: the length of wells.
crsobjectRequiredThe coordinate system the file was read in, and how sure that is.
ShowHide 6 child fields
codestringRequiredThe system read: an EPSG code, as EPSG:2277, or the .prj's name when no supported system matches it (it was read through the .prj itself).
namestringRequiredIts name, as NAD83 / Texas Central (ftUS).
sourcestringRequiredrequest: the request's crs; file: the .prj, the GeoJSON (crs member, or degrees per RFC 7946) or a KML (WGS 84); detected: the first supported system that puts the areas on the dataset.
"request""file""detected"datum_shiftstring or nullRequirednadcon_conus: NAD27, shifted to NAD83 with NOAA's NADCON conus grid; else null.
"nadcon_conus"max_offset_ftintegerRequired≥ 0
The largest alternative's offset_ft, or 0: how far the areas could be off if the file is in another system that also fits.
alternativesarray of objectsRequiredWith detection: the other systems that fit, in preference order, under 1 ft apart listed once.
ShowHide 3 child fields in each item
codestring or nullRequiredIts EPSG code; null for an international-foot variant, which crs can't name.
namestringRequiredIts name.
offset_ftintegerRequired≥ 1
The farthest a sampled vertex lands from where it is read now, ft.
name_fieldstring or nullRequiredThe field the names came from, or null.
fieldsarray of stringsRequiredThe attributes the areas carry, in file order, as POST /areas gives them.
columnsobjectRequiredThe field each role was read from, or null when the file has none.
ShowHide 14 child fields
formationstring or nullRequiredThe field formation was read from, or null.
til_datestring or nullRequiredThe field til_date was read from, or null.
lateral_length_ftstring or nullRequiredThe field lateral_length_ft was read from, or null.
tvd_ftstring or nullRequiredThe field tvd_ft was read from, or null.
fluid_bbl_per_ftstring or nullRequiredThe field fluid_bbl_per_ft was read from, or null.
proppant_lb_per_ftstring or nullRequiredThe field proppant_lb_per_ft was read from, or null.
wells_per_sectionstring or nullRequiredThe field wells_per_section was read from, or null.
spacing_ftstring or nullRequiredThe field spacing_ft was read from, or null.
azimuth_degstring or nullRequiredThe field azimuth_deg was read from, or null.
setback_ftstring or nullRequiredThe field setback_ft was read from, or null.
landing_fractionstring or nullRequiredThe field landing_fraction was read from, or null.
stage_length_ftstringOptionalThe field stage_length_ft was read from; only when the file has it or columns names it.
clusters_per_stagestringOptionalThe field clusters_per_stage was read from; only when the file has it or columns names it.
frac_rate_bbl_per_minstringOptionalThe field frac_rate_bbl_per_min was read from; only when the file has it or columns names it.
unknown_formationsarray of objectsRequiredFormation names that matched nothing, most pads first.
ShowHide 2 child fields in each item
valuestringRequiredA formation name in the file.
padsintegerRequired≥ 1
Pads naming it.
skippedarray of objectsRequiredRecords that aren't areas, as POST /areas lists them.
ShowHide 2 child fields in each item
indexintegerRequired≥ 0
Record or feature index in the file.
reasonstringRequiredWhy it isn't a pad, as POST /areas gives it.
warningsarray of stringsRequiredWhat to check: POST /areas' warnings but the one on holes or several parts, points, a role field past the property cap, pads left out or with issues, unknown formations, filled stage fields the model set's models don't read.
padsarray of objectsRequiredEvery polygon of the file read as an area, in file order.
ShowHide 21 child fields in each item
idintegerRequired≥ 0
Its record (shapefile) or feature (GeoJSON) index in the file, from 0: its area's id.
namestringRequiredIts name: the area's from the name field or fields, trimmed, else Pad <id + 1>; its wells' pad.
outlinearray of [number, number]s or nullRequiredThe area's fill.polygon, open: the ring its wells fill when the area is one part without holes; null when it can't be filled.
acresnumberRequiredIts area's acres, holes taken out.
azimuth_degnumberRequiredThe azimuth its wells run at: its own, else its outline's long axis.
wells_per_sectionintegerRequired≥ 1, ≤ 52
Wells per section its bench lays: its own, else its spacing's, else the request's.
formationstring or nullRequiredIts formation, as GET /formations names it, or null when blank without the request's, or unknown.
lateral_length_ftnumber or nullRequiredIts wells' lateral length, ft, or null for edge to edge.
setback_ftnumberRequired≥ 0
Its lease-line setback, ft.
til_datestring or nullRequiredFormat
dateIts TIL date, or null.
fluid_bbl_per_ftnumber or nullRequiredIts fluid per lateral ft, or null.
proppant_lb_per_ftnumber or nullRequiredIts proppant per lateral ft, or null.
Show all 21 fields
tvd_ftnumber or nullRequiredIts TVD, ft, or null.
landing_fractionnumber or nullRequiredIts landing fraction, 0 at the formation top to 1 at its base, or null.
wellsarray of integersRequiredItems ≥ 0
Its wells' indexes in wells, in fill order; empty when left out.
issuesarray of stringsRequiredWhat was dropped or doubted, and last why it was left out; empty when it read cleanly.
left_outbooleanRequiredTrue when it lays no wells; the last issue says why.
areaobjectOptionalThe area's geometry, which its wells are laid in, when it has holes or several parts.
ShowHide 2 variants
One of
A polygon object
A polygon.
typeanyRequiredAlways
"Polygon"One part.
coordinatesarray of arraysRequiredItems at least 4 items
The outer ring, then its holes.
A multipolygon object
A multipolygon.
typeanyRequiredAlways
"MultiPolygon"Several parts.
coordinatesarray of arraysRequiredThe parts.
stage_length_ftnumber or nullOptionalIts stage length, ft, or null; only when the file has the field.
clusters_per_stagenumber or nullOptionalIts clusters per stage, or null; only when the file has the field.
frac_rate_bbl_per_minnumber or nullOptionalIts frac rate, bbl/min, or null; only when the file has the field.
wellsarray of objectsRequiredThe kept pads' wells, pad by pad, then in fill order: shl, bhl, formation and pad, ready to post as wells to POST /plans.
ShowHide 22 child fields in each item
shl[number, number]RequiredSurface hole location, [lng, lat].
bhl[number, number]RequiredBottom hole (toe) location, [lng, lat]. The lateral runs from heel, else shl, to bhl and must be 100 to 50,000 ft long.
formationstring or nullOptionalTarget formation (case-insensitive; GET /formations lists them). Needed to forecast and to estimate TVD.
tvd_ftnumber or nullOptional> 0, < 40000
True vertical depth in ft. Blank estimates it from the structure grid and nearby wells.
landing_below_top_ftnumber or nullOptional> -40000, < 40000
Instead of tvd_ft: how far below the formation top to land, ft. TVD is the formation top at the well plus this, the top in the set's TVD datum as POST /tvd-estimates' formation_top_ft gives it; needs formation and a grid there. The top is averaged over the well's surface and bottom hole, whatever the set's
subsurface_sampling(GET /model-sets).heel[number, number] or nullOptionalWhere the lateral starts, [lng, lat], when not at
shl, the surface hole; absent or null, it starts atshl.shlmust be within 50,000 ft of it.With it, the lateral length and its 100 to 50,000 ft check, spacing, gun barrel laterals, PDP wells and model analogs run from heel to bhl. Subsurface grids still sample at
shlandbhlas the set'ssubsurface_samplingsays, and structure tops, landing, TVD estimates, the KB elevation and the model's surface hole inputs stay atshl.typed_lateralobject or nullOptionalA lateral length typed for the well, as an inventory file gives it:
length_ft, and theheel(the well's heel, else itsshl) andbhlit was typed for.The model gets
length_ftasnovi_lateral_length, and spacing, the completion totals, analogs, normalize_lateral_ft and pricing use it, while the well's heel (else shl) and bhl equal those two exactly and it is within 5% of the length measured between them or within 100 to 50,000 ft; otherwise the measured length. A client that moves an end can send it unchanged: the well then uses the measured length.Reads give the length used as
lateral_length_ft, withlateral_length_source. Optional: absent or null, the measured length.POST /inventories/read sets it from a file's stated length unless that is both more than 5% off the drawn one and outside 100 to 50,000 ft, with an issue when it is more than 5% off.
ShowHide 3 child fields
length_ftnumberRequired≥ 0, ≤ 1000000
The typed length, ft.
heel[number, number]RequiredWhere the lateral started when the length was typed: the well's heel, else its shl, [lng, lat].
bhl[number, number]RequiredThe bottom hole the length was typed for, [lng, lat].
lateral_outsidestring or nullOptionalIgnored; accepted so POST /layouts/fill wells with lateral_check can be sent as they are.
"above""below"landing_fractionnumber or nullOptional≥ 0, ≤ 1
Instead of tvd_ft or landing_below_top_ft: where to land as a fraction of the formation's thickness, 0 at its top to 1 at its base (0.5 the middle). TVD is top + landing_fraction × (base − top), to the foot.
The top is the formation's structure grid: the set's own, else a TVD-only one in its depth pack. The base is the top of the next formation down the rock column with a grid at an end of the well (shl, bhl) the formation's own grid reaches.
The rock column ranks the set's structure grids and its depth pack's TVD-only ones from the grids, not GET /formations order: at sample points spread over the grids' lattices, one lies below another when its top is a foot or more deeper at more of the points both reach than the reverse, or by median depth when they share none. Grids are ordered by how many others each lies below, less how many lie below it, ties by median depth. A grid with no value at any sample point is left out. Grids within a foot of each other wherever both reach are one surface: neither is the other's base, and both take the next surface below.
Top and base are each averaged over the ends both grids reach, in the set's TVD datum as POST /tvd-estimates' formation_top_ft, and tvd_source names the base's formation. When the set's depth pack names a thickness grid, the base is the top plus that grid instead, and tvd_source names it. With a depth pack, a formation with no gridded formation below it at the well (as the deepest one) takes its base from its novi_thickness_avg grid.
Needs formation. The well is refused as landing_below_top_ft is, naming landing_fraction, when:
- its formation has no grid there or no place in the column;
- no formation below it has a grid at an end its own grid reaches and, with a depth pack, it has no novi_thickness_avg grid there either (the error says when the grids reach different ends);
- the base's top is a foot or more above the formation's at either end: the grids cross, the error names shl or bhl, and no deeper formation is tried;
- top and base averaged over the ends are under a foot apart: the zone pinches out.
A well's inputs echo it when it was sent.
lateral_length_ftnumber or nullOptionalIgnored: the lateral runs from heel, else shl, to bhl, unless
typed_lateralapplies. Accepted so POST /layouts/fill wells can be sent as they are.til_datestring or nullOptionalFormat
dateTIL (turn-in-line, first production) date, YYYY-MM-DD: ip_day 1 is this day.
From GET /dataset as_of to 30 years from today. Blank takes the next wider layer's date, the request's til_date last, else today. In spacing it orders parents and children (a well online at least 90 days before a neighbor is its parent, and the parent's days online count from it) and dates every spacing feature row.
partinteger or nullOptionalIgnored, as is bench: accepted so POST /layouts/fill wells can be sent as they are.
Show all 22 fields
benchinteger or nullOptionalIgnored.
padnumber or string or nullOptionalThe pad the well is on: a whole number, as POST /layouts/fill numbers them, or text of 1 to 60 characters, trimmed; 1 and "1" are one pad.
POST /plans keeps a valid key whenever sent, for
group_by=padand thepad=filter, and doesn't echo it on wells; other requests read it only withpads. It is checked (a 400 on a bad value) only withpads; withoutpads, a value that isn't a pad is ignored.scenariostringOptional1 to 60 characters
The alternative the well is in: a scenario's wells space against only each other and existing wells, never another scenario's. A name of 1 to 60 characters, trimmed.
Equal names (exact, case-sensitive) are one scenario; with pdp false its wells space against only each other. Give every well a scenario, or none (400 at the first without one). At most 10 scenarios on POST /forecasts, each its own spacing run, and 20 on POST /plans (400 at the first well past it, with details.max and details.count). Designs and pdp apply to every scenario unless
scenariossets its own.fluid_bbl_per_ftnumber or nullOptional> 0, < 1000
This well's fluid in bbl per lateral ft.
Each field takes the narrowest layer that sets it, on its own: the well, its pad's entry in
padsor its layout (the bench or formation entry, then overall), its entry inscenarios(formation entry, then overall), the design'sformationsentry for its formation, the design, then the default: the recent-completions median of the well's formation, else the play's.Needs one design or none; with more, the request is a 400 naming the well. POST /gun-barrels refuses it. Sending one adds
resolvedto every well'sinputsin the request.proppant_lb_per_ftnumber or nullOptional> 0, < 20000
This well's proppant in lb per lateral ft.
Each field takes the narrowest layer that sets it, on its own: the well, its pad's entry in
padsor its layout (the bench or formation entry, then overall), its entry inscenarios(formation entry, then overall), the design'sformationsentry for its formation, the design, then the default: the recent-completions median of the well's formation, else the play's.Needs one design or none; with more, the request is a 400 naming the well. POST /gun-barrels refuses it. Sending one adds
resolvedto every well'sinputsin the request.stage_length_ftnumber or nullOptional> 0, < 2000
Stage length in ft.
Read only on a model set whose models use it (GET /completions/defaults?include=inputs lists which); elsewhere it is accepted, changes nothing and is listed in the design's
unused. It layers as fluid_bbl_per_ft does. A blank takes the median of the well's formation over the set's recent wells, else the play's; with neither, the request is a 400 naming the design's field.clusters_per_stagenumber or nullOptional> 0, < 100
Perforation clusters per stage; fractions are accepted.
Read only on a model set whose models use it (GET /completions/defaults?include=inputs lists which); elsewhere it is accepted, changes nothing and is listed in the design's
unused. It layers as fluid_bbl_per_ft does. A blank takes the median of the well's formation over the set's recent wells, else the play's; with neither, the request is a 400 naming the design's field.frac_rate_bbl_per_minnumber or nullOptional> 0, < 500
Frac pump rate in bbl per minute.
Read only on a model set whose models use it (GET /completions/defaults?include=inputs lists which); elsewhere it is accepted, changes nothing and is listed in the design's
unused. It layers as fluid_bbl_per_ft does. A blank takes the median of the well's formation over the set's recent wells, else the play's; with neither, the request is a 400 naming the design's field.declineobjectOptionalEUR settings for this well; needs
euron.With
euroff, adeclineon any layer is a 400, even{}or one that reaches no well, though either sets nothing. POST /exportssourceturnseuron when it is left out.Each field takes the narrowest value set: the well's; its pad's or layout's,
formationsentry or bench first; its scenario's,formationsentry first; the request'sformationsentry; the request'sdecline; Novi's defaults. The narrower layer wins first; within a layer, a stream's value beats the base: a well'sb_maxbeats a plan'soil.b_max. Once a value reaches a well, every well'sinputs.resolved.declinegives each value and its layer, and the export's wells table adds them.A well whose
b_minresolves at or above itsb_maxis a 400 naming the well and both layers. The ARIES export refuses a scope whose wells differ. POST /gun-barrels and POST /economicsforecastrefuse adecline.ShowHide 7 child fields
eur_yearsintegerOptional≥ 10, ≤ 50
Years to EUR: the extension runs to the last 30-day step within eur_years × 365 days.
terminal_declinenumberOptional≥ 0.01, ≤ 0.2
Terminal decline, a fraction per year: the hyperbolic switches to exponential at this rate.
b_minnumberOptional≥ 0, ≤ 2.5
Lowest hyperbolic b the fit may use; below b_max.
b_maxnumberOptional≥ 0, ≤ 2.5
Highest hyperbolic b the fit may use; above b_min.
oilobjectOptionalOil's own settings over these.
ShowHide 3 child fields
terminal_declinenumberOptional≥ 0.01, ≤ 0.2
Terminal decline, a fraction per year: the hyperbolic switches to exponential at this rate.
b_minnumberOptional≥ 0, ≤ 2.5
Lowest hyperbolic b the fit may use; below b_max.
b_maxnumberOptional≥ 0, ≤ 2.5
Highest hyperbolic b the fit may use; above b_min.
gasobjectOptionalGas's own settings over these.
Same fields as StreamDeclineSettings.
waterobjectOptionalWater's own settings over these, only with eur_water: true, else a 400. Unlike oil and gas it doesn't set per-stream settings: oil and gas keep theirs and their calls.
Same fields as StreamDeclineSettings.
namestring or nullOptionalup to 60 characters
Your name for the well, 1 to 60 characters once trimmed, on POST /plans, POST /forecasts and POST /inventories/write; other routes that take wells answer 400. null is none; a blank name is a 400.
Names needn't be unique. Reads show it beside
label, which stays Plan well N (Drawn well N on POST /forecasts). A plan's export tables put it in theirwellcolumn, keeping their row order, with a leading quote where a spreadsheet would read it as a formula. ARIES heads the well with it, unquoted, and sorts by header, so wells with one name share a header: sendaries.well_key: idto keep them apart.
pad_valuesarray of objectsRequiredA PadInput for each kept pad, with its TIL date, completions and landing when the file gives them, ready to post as pads to POST /plans with wells.
ShowHide 13 child fields in each item
padinteger or stringRequired1 to 60 characters
The pad these values are for: an integer or text as the wells name it, trimmed, at most 60 characters, each once; 1 and "1" are one pad.
namestring or nullOptionalup to 60 characters
The pad's name, 1 to 60 characters once trimmed; null is none, and a blank name is a 400. Names needn't be unique: the key still groups and orders pads, pairs them in comparisons and filters with
pad=.POST /plans keeps it: the economics export's
padcolumn writes it instead of the key on well and pad rows, GET /plans/{id}/stats?group_by=pad gives it asgroups[].name, GET /plans/{id}/rollup aspads[].name, and the type curve, plan economics and comparisons by pad give it beside the key. POST /forecasts and POST /exportssourcecheck it but don't use it.fluid_bbl_per_ftnumber or nullOptional> 0, < 1000
Fluid in bbl per lateral ft for the pad's wells: below a well's own and a
formationsentry here, above a scenario's and the design's. Needs one design, or none.proppant_lb_per_ftnumber or nullOptional> 0, < 20000
Proppant in lb per lateral ft for the pad's wells, as fluid_bbl_per_ft is set.
stage_length_ftnumber or nullOptional> 0, < 2000
Stage length in ft.
Read only on a model set whose models use it (GET /completions/defaults?include=inputs lists which); elsewhere it is accepted, changes nothing and is listed in the design's
unused. It layers as fluid_bbl_per_ft does. A blank takes the median of the well's formation over the set's recent wells, else the play's; with neither, the request is a 400 naming the design's field.clusters_per_stagenumber or nullOptional> 0, < 100
Perforation clusters per stage; fractions are accepted.
Read only on a model set whose models use it (GET /completions/defaults?include=inputs lists which); elsewhere it is accepted, changes nothing and is listed in the design's
unused. It layers as fluid_bbl_per_ft does. A blank takes the median of the well's formation over the set's recent wells, else the play's; with neither, the request is a 400 naming the design's field.frac_rate_bbl_per_minnumber or nullOptional> 0, < 500
Frac pump rate in bbl per minute.
Read only on a model set whose models use it (GET /completions/defaults?include=inputs lists which); elsewhere it is accepted, changes nothing and is listed in the design's
unused. It layers as fluid_bbl_per_ft does. A blank takes the median of the well's formation over the set's recent wells, else the play's; with neither, the request is a 400 naming the design's field.til_datestring or nullOptionalFormat
dateTIL date for the pad's wells without their own, over a scenario's and the request's til_date.
TIL (turn-in-line, first production) date, YYYY-MM-DD: ip_day 1 is this day.
From GET /dataset as_of to 30 years from today. Blank takes the next wider layer's date, the request's til_date last, else today. In spacing it orders parents and children (a well online at least 90 days before a neighbor is its parent, and the parent's days online count from it) and dates every spacing feature row.
tvd_ftnumber or nullOptional> 0, < 40000
True vertical depth in ft for the pad's wells. Landing falls through as one unit, so a well, or a
formationsentry here, that sets any landing field keeps it.landing_below_top_ftnumber or nullOptional> -40000, < 40000
Instead of tvd_ft: ft below the top of each well's own formation; a well that takes it needs one.
landing_fractionnumber or nullOptional≥ 0, ≤ 1
Instead of tvd_ft or landing_below_top_ft: 0 at the top of each well's own formation to 1 at its base; a well that takes it needs one.
declineobjectOptionalEUR settings for the pad's wells; needs
euron.With
euroff, adeclineon any layer is a 400, even{}or one that reaches no well, though either sets nothing. POST /exportssourceturnseuron when it is left out.Each field takes the narrowest value set: the well's; its pad's or layout's,
formationsentry or bench first; its scenario's,formationsentry first; the request'sformationsentry; the request'sdecline; Novi's defaults. The narrower layer wins first; within a layer, a stream's value beats the base: a well'sb_maxbeats a plan'soil.b_max. Once a value reaches a well, every well'sinputs.resolved.declinegives each value and its layer, and the export's wells table adds them.A well whose
b_minresolves at or above itsb_maxis a 400 naming the well and both layers. The ARIES export refuses a scope whose wells differ. POST /gun-barrels and POST /economicsforecastrefuse adecline.Same fields as DeclineSettings.
formationsarray of objectsOptionalup to 100 items
Values for the pad's wells in one formation, each formation at most once.
ShowHide 10 child fields in each item
formationstringRequiredFormation (case-insensitive; GET /formations lists them).
fluid_bbl_per_ftnumber or nullOptional> 0, < 1000
Fluid in bbl per lateral ft for this formation's wells in the scenario or pad, over the entry's own. Needs one design, or none.
proppant_lb_per_ftnumber or nullOptional> 0, < 20000
Proppant in lb per lateral ft, as fluid_bbl_per_ft is set.
stage_length_ftnumber or nullOptional> 0, < 2000
Stage length in ft.
Read only on a model set whose models use it (GET /completions/defaults?include=inputs lists which); elsewhere it is accepted, changes nothing and is listed in the design's
unused. It layers as fluid_bbl_per_ft does. A blank takes the median of the well's formation over the set's recent wells, else the play's; with neither, the request is a 400 naming the design's field.clusters_per_stagenumber or nullOptional> 0, < 100
Perforation clusters per stage; fractions are accepted.
Read only on a model set whose models use it (GET /completions/defaults?include=inputs lists which); elsewhere it is accepted, changes nothing and is listed in the design's
unused. It layers as fluid_bbl_per_ft does. A blank takes the median of the well's formation over the set's recent wells, else the play's; with neither, the request is a 400 naming the design's field.frac_rate_bbl_per_minnumber or nullOptional> 0, < 500
Frac pump rate in bbl per minute.
Read only on a model set whose models use it (GET /completions/defaults?include=inputs lists which); elsewhere it is accepted, changes nothing and is listed in the design's
unused. It layers as fluid_bbl_per_ft does. A blank takes the median of the well's formation over the set's recent wells, else the play's; with neither, the request is a 400 naming the design's field.tvd_ftnumber or nullOptional> 0, < 40000
True vertical depth in ft. Landing falls through as one unit: a well, or a narrower layer, that sets any of tvd_ft, landing_below_top_ft or landing_fraction keeps its own, so this reaches only wells that set none.
landing_below_top_ftnumber or nullOptional> -40000, < 40000
Instead of tvd_ft: ft below the formation top, as on a well.
landing_fractionnumber or nullOptional≥ 0, ≤ 1
Instead of tvd_ft or landing_below_top_ft: 0 at the formation top to 1 at its base, as on a well.
declineobjectOptionalEUR settings for this formation's wells in the scenario or pad; needs
euron.With
euroff, adeclineon any layer is a 400, even{}or one that reaches no well, though either sets nothing. POST /exportssourceturnseuron when it is left out.Each field takes the narrowest value set: the well's; its pad's or layout's,
formationsentry or bench first; its scenario's,formationsentry first; the request'sformationsentry; the request'sdecline; Novi's defaults. The narrower layer wins first; within a layer, a stream's value beats the base: a well'sb_maxbeats a plan'soil.b_max. Once a value reaches a well, every well'sinputs.resolved.declinegives each value and its layer, and the export's wells table adds them.A well whose
b_minresolves at or above itsb_maxis a 400 naming the well and both layers. The ARIES export refuses a scope whose wells differ. POST /gun-barrels and POST /economicsforecastrefuse adecline.Same fields as DeclineSettings.
name_fieldsarray of stringsOptionalAs POST /areas gives them, only when the request sent name_fields: those fields as the file spells them, in the order sent; name_field is the first.
name_separatorstringOptionalAs POST /areas gives them, only when the request sent name_fields: what joined their values.
Errors
| Status | When |
|---|---|
| 413 | The request body is over 10 MB. |
Shared errors400401403500503What they mean