Skip to content
Developers
Get an API token

List the inventory upload's columns

The upload's column catalog, in template order: each column's key, reader roles, headers and units, shapefile field, whether it is required, the request flag it needs and its aliases (see InventoryColumn).

List the inventory upload's columns

GET/inventories/columns

The upload's column catalog, in template order: each column's key, reader roles, headers and units, shapefile field, whether it is required, the request flag it needs and its aliases (see InventoryColumn). It doesn't depend on model_set and changes only with a deploy.

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

A shapefile's field names carry no unit: TVD, LATERALLEN and STAGE_LEN read as POST /inventories/read's units text says, FLUIDPERFT, PROPPERFT and FRAC_BPM in bbl/ft, lb/ft and bbl/min, and CLUST_STG as a count.

Template

GET /inventories/template writes these headers as one line (Stage Length, Clusters per Stage and Frac Rate only where the model set's models read them); fill one well per row and send it to POST /inventories/read. The read needs eur_water: true for the water decline columns, til_from_dates for the drill and completion dates, and designs_from_rows: true for completion names.

Responses

200 OK

The inventory column catalog.

  • columnsarray of objectsRequired

    Columns in template order.

    ShowHide 10 child fields in each item
    • keystringRequired

      Stable column key; its primary reader role.

    • rolesarray of stringsRequired

      Roles this column can fill, primary first; Heelpoint also fills shl when Top Hole is absent.

    • headerstringRequired

      The imperial template header.

    • headersobjectRequired

      Headers by unit system.

      ShowHide 2 child fields
      • imperialstringRequired

        Imperial template header.

      • metricstringRequired

        Metric template header.

    • fieldstring or nullRequired

      A shapefile's attribute name of up to 10 characters, or null for CSV positions.

    • unitobject or nullRequired

      The units in CSV, GeoJSON and Excel headers, or null for columns without unit headers; a shapefile's field name carries none (POST /inventories/read's Units text says how it reads).

      ShowHide 2 child fields
      • imperialstringRequired

        Imperial unit.

      • metricstringRequired

        Metric unit.

    • requiredstringRequired

      yes: required unless the request sends formation; csv: required for CSV lateral ends, with Top Hole able to stand in for Heelpoint; no: optional.

      "yes""csv""no"
    • reads_withstring or nullRequired

      Request flag needed to read this column, or null.

    • descriptionstringRequired

      What the value means and how it is read.

    • aliasesarray of stringsRequired

      Lowercased letters-and-digits names the upload compares, in match order.

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

Errors

Shared errors401403500What they mean