Well

the well table defines the well header — the well's identity, classification, and location every other dataset in the schema hangs off a well record the well's sourceid must be globally unique, and its uwi must match the identifier used by your production allocation system variable data type unit of measure is nullable? default value description sourceid string no source id for the well from wellview wvwellheader table, idwell column from openwells cd well table, well id column uwi string no unique well identifier this key links the well to daily production from your allocation system name string no well name group1 string yes well group 1 (often field or asset) group2 string yes well group 2 (often route or facility) group3 string yes well group 3 (often pad or cluster) type string no producer well type producer injector fluid string no oil fluid type oil gas water condensate lifttype string no natural flow artificial lift type natural flow annular natural flow dual natural flow gas lift annular gas lift plunger lift plunger assisted gas lift gas assisted plunger lift rod pump esp pcp lat double decimal degrees, wgs84 crs no surface latitude used for maps and to resolve the well's time zone lon double decimal degrees, wgs84 crs no surface longitude used for maps and to resolve the well's time zone middlelat double decimal degrees, wgs84 crs yes optional middle latitude (for maps) frequently the lateral heel coordinate middlelon double decimal degrees, wgs84 crs yes optional middle longitude (for maps) frequently the lateral heel coordinate bottomholelat double decimal degrees, wgs84 crs yes optional bottomhole latitude (for maps) frequently the lateral toe coordinate bottomholelon double decimal degrees, wgs84 crs yes optional bottomhole longitude (for maps) frequently the lateral toe coordinate mudline double ft yes depth of the mud line for offshore wells null for onshore wells status string yes active well status, used to exclude inactive wells from modeling and network optimization active inactive abandoned area string yes sub area of the 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 responsibleengineer string yes engineer responsible for the well heritage string yes previous company that owned the well grouping fields group1, group2, group3 the group fields drive navigation and reporting a well can be grouped at three levels, typically unconventional group1 = field group2 = route group3 = pad conventional group1 = asset group2 = facility group3 = cluster you decide which field from your source system maps to each level, and any level can be left empty whatever convention you choose, apply it consistently across all wells the explicit metadata fields (area, centralfacility, tankbattery, route, pad, platform) can be used alongside the group fields for richer filtering 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 uwi missing, too short/long, or has leading/trailing spaces uwi length must be between 2 and 16 chars and cannot contain leading or trailing spaces fetch a well sourceid not found well with sourceid xxx does not exist fetch a well uwi not found well with uwi xxx was not found delete a well sourceid not found well with sourceid xxx was not found