Skip to content
Developers
Get an API token

Describe the subsurface model

The subsurface dataset, interpolation config, formations, rock properties and every grid with its unit.

Describe the subsurface model

GET/subsurface

The 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.

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

Parameters

Query parameters

  • 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

Subsurface model.

  • datasetobjectRequired

    Subsurface dataset.

    ShowHide 3 child fields
    • idintegerRequired

      Id.

    • namestringRequired

      Name.

    • build_numstringRequired

      Build.

  • configobjectRequired

    Interpolation config: method, projection and params.distance_from_grids.

  • formationsarray of stringsRequired

    Formations with grids.

  • propertiesarray of stringsRequired

    Rock properties.

  • gridsarray of objectsRequired

    Grids.

    ShowHide 4 child fields in each item
    • feature_namestringRequired

      Grid name.

    • formationstringRequired

      Formation.

    • rock_propertystringRequired

      Property.

    • unitstring or nullRequired

      ft or fraction.

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

Errors

Shared errors400401403500503What they mean