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
/inventories/columnsThe 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.
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 objectsRequiredColumns in template order.
ShowHide 10 child fields in each item
keystringRequiredStable column key; its primary reader role.
rolesarray of stringsRequiredRoles this column can fill, primary first; Heelpoint also fills shl when Top Hole is absent.
headerstringRequiredThe imperial template header.
headersobjectRequiredHeaders by unit system.
ShowHide 2 child fields
imperialstringRequiredImperial template header.
metricstringRequiredMetric template header.
fieldstring or nullRequiredA shapefile's attribute name of up to 10 characters, or null for CSV positions.
unitobject or nullRequiredThe 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
imperialstringRequiredImperial unit.
metricstringRequiredMetric unit.
requiredstringRequiredyes: 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 nullRequiredRequest flag needed to read this column, or null.
descriptionstringRequiredWhat the value means and how it is read.
aliasesarray of stringsRequiredLowercased letters-and-digits names the upload compares, in match order.
304 Unchanged since the ETag in If-None-Match.Errors
Shared errors401403500What they mean