Describe the subsurface model
The subsurface dataset, interpolation config, formations, rock properties and every grid with its unit.
Describe the subsurface model
/subsurfaceThe subsurface dataset, interpolation config, formations, rock properties and every grid with its unit. Structural depth is subsea ft (negative below sea level), the grid as the model set stores it; POST /tvd-estimates and POST /gun-barrels give tops in the set's TVD datum (tvd_datum). Thickness is ft; BVI is a fraction.
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.
Responses
200 OK
Subsurface model.
datasetobjectRequiredSubsurface dataset.
ShowHide 3 child fields
idintegerRequiredId.
namestringRequiredName.
build_numstringRequiredBuild.
configobjectRequiredInterpolation config: method, projection and params.distance_from_grids.
formationsarray of stringsRequiredFormations with grids.
propertiesarray of stringsRequiredRock properties.
gridsarray of objectsRequiredGrids.
ShowHide 4 child fields in each item
feature_namestringRequiredGrid name.
formationstringRequiredFormation.
rock_propertystringRequiredProperty.
unitstring or nullRequiredft or fraction.
304 Unchanged since the ETag in If-None-Match.Errors
Shared errors400401403500503What they mean