Get a grid's points
A grid's lattice points as parallel lng, lat and val arrays, its value range (with 2nd and 98th percentiles for color ramps) and, when the points sit on a regular lng/lat lattice, its origin, steps and size.
Get a grid's points
/subsurface/grids/{feature_name}A grid's lattice points as parallel lng, lat and val arrays, its value range (with 2nd and 98th percentiles for color ramps) and, when the points sit on a regular lng/lat lattice, its origin, steps and size. Points outside the formation's footprint are left out, so rebuild the lattice from lattice and treat missing points as no data.
Parameters
Path parameters
feature_namestringRequiredGrid name from GET /subsurface, as novi_structuraldepth_wolfcamp_a.
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.
Responses
200 OK
Grid points.
feature_namestringRequiredGrid name.
formationstringRequiredFormation.
rock_propertystringRequiredProperty.
unitstring or nullRequiredft or fraction.
countintegerRequiredPoints.
rangeobjectRequiredValue range.
ShowHide 4 child fields
minnumber or nullRequiredMinimum.
p02number or nullRequired2nd percentile.
p98number or nullRequired98th percentile.
maxnumber or nullRequiredMaximum.
latticeobject or nullRequiredThe regular lattice under the points, or null.
ShowHide 6 child fields
lng0numberRequiredWestmost column longitude.
lat0numberRequiredSouthmost row latitude.
step_lngnumberRequiredColumn step, degrees.
step_latnumberRequiredRow step, degrees.
nxintegerRequiredColumns.
nyintegerRequiredRows.
lngarray of numbersRequiredPoint longitudes.
latarray of numbersRequiredPoint latitudes.
valarray of numbersRequiredPoint values.
304 Unchanged since the ETag in If-None-Match.Errors
| Status | When |
|---|---|
| 404 | No such well, grid, plan or route. |
Shared errors400401403500503What they mean