Skip to content
Developers
Get an API token

Get what fields and Legacy Forecasts names mean

Names in one read: fields, export columns, model tables and Legacy Forecasts names.

Get what fields and Legacy Forecasts names mean

GET/field-dictionary

Names in one read: fields, export columns, model tables and Legacy Forecasts names. None is an alias: the API accepts none of them. It changes only with a deploy, so it carries an ETag.

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

fields: the properties of WellInput, Design, PlanWellSummary, ForecastWell, ResolvedInputs, ShapRow, ContributingWell, SpacingNeighbor, less those they ignore, each with its type, the unit its name carries and its description. GET /openapi.json has the other schemas'.

Export columns

export_columns: every export table's columns as GET /export-formats lists them with eur and eur_water (well with a plan's description); added_by_plan marks those only some plans add to wells. model_tables names the tables that write a plan's own columns.

Legacy Forecasts names

fe_names: the output names of Novi's earlier Forecast Engine, each with the field or export column that carries it, or "none". Its note says which names it leaves out.

Responses

200 OK

The field dictionary.

  • api_versionstringRequired

    API version.

  • fieldsarray of objectsRequired

    The fields, in schema order.

    ShowHide 5 child fields in each item
    • namestringRequired

      Field name.

    • schemastringRequired

      The schema in this document that holds it; a name can appear under several.

    • typestringRequired

      Its type without null, as number or as a schema in this document.

    • unitstring or nullRequired

      The unit its name carries, from a suffix of _ft, _bbl_per_ft or _lb_per_ft. Null when the name carries none; the description then gives any unit.

    • descriptionstringRequired

      What it means, as this document says.

  • export_columnsarray of objectsRequired

    The export columns, table by table.

    ShowHide 8 child fields in each item
    • tablestringRequired

      Table id.

      "monthly""arps""eur""wells""designs""forecast""neighbors""calc_features""subsurface""shap""valnav_decline""combocurve_wells""combocurve_forecast""economics"
    • filestringRequired

      Its file in the zip.

    • namestringRequired

      Column name.

    • unitstring or nullRequired

      Unit, as bbl or day.

    • descriptionstringRequired

      What it holds.

    • defaultbooleanRequired

      Written when the request names no columns.

    • streamstring or nullRequired

      The stream the column belongs to.

      "oil""gas""water"
    • added_by_planbooleanRequired

      True when GET /export-formats doesn't list it: a plan adds it to the wells table, whatever columns are chosen, when the plan sets what it reports.

  • model_tablesarray of objectsRequired

    The tables with no fixed columns: each writes the plan's own.

    ShowHide 3 child fields in each item
    • tablestringRequired

      Table id.

      "monthly""arps""eur""wells""designs""forecast""neighbors""calc_features""subsurface""shap""valnav_decline""combocurve_wells""combocurve_forecast""economics"
    • filestringRequired

      Its file in the zip.

    • descriptionstringRequired

      What it holds.

  • fe_namesobjectRequired

    Legacy Forecasts names: the output names of Novi's earlier Forecast Engine.

    ShowHide 3 child fields
    • notestringRequired

      How to read these rows.

    • not_mappedarray of stringsRequired

      Job settings and bookkeeping names, which have no row.

    • groupsarray of objectsRequired

      The names, grouped.

      ShowHide 3 child fields in each item
      • titlestringRequired

        Heading.

      • notestring or nullRequired

        What applies to every row of the group.

      • rowsarray of objectsRequired

        Its names.

        ShowHide 5 child fields in each item
        • namestringRequired

          The Legacy Forecasts name.

        • fe_tablesarray of stringsRequired

          The output tables that have it.

        • v2stringRequired

          The field or export column that carries it, in words. A name can map differently per output table; the text says how.

        • nonebooleanRequired

          True when v2 has no field for it in any of those tables. False when one table has one, or v2 has only a near match: v2 then says so.

        • columnsarray of objectsRequired

          The export columns v2 names; empty when it names only API fields.

          ShowHide 2 child fields in each item
          • tablestringRequired

            Table id.

            "monthly""arps""eur""wells""designs""forecast""neighbors""calc_features""subsurface""shap""valnav_decline""combocurve_wells""combocurve_forecast""economics"
          • namestringRequired

            Column name.

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

Errors

Shared errors401403500What they mean