Skip to content
Developers
Get an API token

Sample grids along a well

Every grid interpolated (linear, on each lattice's triangulation) where the set reads its grids (GET /model-sets?include=subsurface_sampling): at the bottom hole, the surface hole or both averaged, as the models see a well.

Sample grids along a well

GET/subsurface/sample

Every grid interpolated (linear, on each lattice's triangulation) where the set reads its grids (GET /model-sets?include=subsurface_sampling): at the bottom hole, the surface hole or both averaged, as the models see a well.

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

Each value's distance to its grid is in _novi_dist (see values); a point outside a grid takes its nearest point's value. A point farther than distance_from_grids from a grid is left out of that grid's value, which is null when no point has one. With a formation, the bare property names (novi_bvi_avg, ...) hold that formation's values.

Parameters

Query parameters

  • shlstringRequired

    Surface hole, lng,lat.

  • bhlstringRequired

    Bottom hole, lng,lat.

  • formationstringOptional

    Target formation, case-insensitive.

  • 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

Interpolated values.

  • formationstring or nullRequired

    Target formation.

  • shl[number, number]Required

    A point as [longitude, latitude] in WGS 84 degrees.

  • bhl[number, number]Required

    A point as [longitude, latitude] in WGS 84 degrees.

  • valuesobjectRequired

    Value per grid, distance per grid (_novi_dist: the mean of the read points' distances to the grid, each 0 inside it, in the config's units), bare property names for the formation and novi_min_grid_dist.

Conditional requests 304 Unchanged since the ETag in If-None-Match.

Errors

Shared errors400401403500503What they mean