Data Schema
Well
Well
the well table defines a "well header" with important information about the well, its identifiers, and the location the well's sourceid must be globally unique variable data type unit of measure is nullable? default value description sourceid string no source id for well from wellview table wvwellheader use idwell column from openwells table cd well use well id column uwi string no unique well identifier this should be a key that links to the production allocation system for daily production name string no well name group1 string yes well group 1 (often asset) group2 group2 string string yes yes \[deprecated will be removed before eoy 2025] \[deprecated will be removed before eoy 2025] well group 2 well group 2 group3 group3 string string yes yes \[deprecated will be removed before eoy 2025] \[deprecated will be removed before eoy 2025] well group 3 well group 3 type string no producer well type producer injector fluid string no oil fluid type oil gas water lifttype string no natural flow artificial lift type natural flow gas lift rod pump esp plunger lift gas assisted plunger lift pcp lat double decimal degrees, wgs84 crs no surface latitude coordinate (for time zone reference and maps) lon double decimal degrees, wgs84 crs no surface longitude coordinate (for time zone reference and maps) middlelat double decimal degrees, wgs84 crs yes optional middle coordinate (for maps) frequently the lateral heel coordinates middlelon double decimal degrees, wgs84 crs yes optional middle coordinate (for maps) frequently the lateral heel coordinates bottomholelat double decimal degrees, wgs84 crs yes optional bottomhole latitude coordinate (for maps) frequently the lateral toe coordinates bottomholelon double decimal degrees, wgs84 crs yes optional bottomhole longitude coordinate (for maps) frequently the lateral toe coordinates mudline double ft yes depth of the mud line for offshore wells for onshore wells, the value will be null status string yes active well status used to skip inactive wells for modeling and network optimization possible values active inactive abandoned area string yes sub area of a field/asset defined by group1 centralfacility string yes central facility into which the well flows tankbattery string yes tank battery into which the well flows route string yes route on which the well is located pad string yes pad (if applicable) on which the well is located platform string yes platform (if applicable) to which the well flows grouping fields group1, group2, group3 \[group2 and group3 are now depracated and will be removed by eoy 2025 they have been replaced by explicit metadata fields like asset, route, pad, etc ] \[group2 and group3 are now depracated and will be removed by eoy 2025 they have been replaced by explicit metadata fields like asset, route, pad, etc ] the group fields are used primarily for navigation and reporting purposes a well can be grouped at three levels typically this would be as follows unconventional group1 = field group2 = route group3 = pad conventional group1 = asset group2 = facility group3 = cluster when adding wells to the well table, you decide which grouping data field from your source system is assigned to each grouping you can also leave all/any grouping as null or empty the important thing is that whatever you decide to use as groupings, you apply consistently across all wells data integrity checks condition response uwi is null or empty record rejected type is null or empty value defaults to producer fluid is null or empty value defaults to oil lifttype is null or empty value defaults to natural flow common error messages api scenario error response add / upsert a well missing uwi add / upsert a well uwi < 2 characters or > 16 characters uwi length must be between 2 and 16 chars add / upsert a well uwi contains leading or trailing space characters uwi must not contain leading or trailing spaces fetch a well missing or invalid uwi delete a well missing or invalid uwi uwi {uwi name} was not found