Allocation
The Allocation table is only needed when a well's Daily ProductionDaily Production comes from a metered source (e.g. a multiphase flow meter) and you also want to track allocated volumes. In that case, push the measured rates to Daily Production and the allocated volumes here, so forecasting results stay consistent with business reporting standards. If Daily Production is your single source of truth, this table does not need to be populated.
The unique constraint on allocation entries is uwi + date.
Variable | Data Type | Unit of Measure | Is Nullable? | Default Value | Description |
|---|---|---|---|---|---|
uwi | String | - | No | - | Unique Well Identifier. Must match the uwi of a record in the WellWell table. |
date | Datetime Offset | - | No | - | Allocation date. Datetime offset (with timezone) in ISO 8601 format. Example: 2022-09-27T16:28:37+0000 |
oilRate | Double | STB/d | No | - | Allocated oil rate |
gasRate | Double | Mscf/d | No | - | Allocated gas rate |
waterRate | Double | STB/d | No | - | Allocated water rate |
factor | Double | - | No | - | Allocation factor applied for the day |
Data Integrity Checks
Condition | Response |
|---|---|
uwi is NULL or empty | Record Rejected |
uwi does not exist in the Well table | Record Rejected |
Any non-nullable field is NULL | Record Rejected |
Common Error Messages
API | Scenario | Error Response |
|---|---|---|
Add / Upsert allocation | Unknown UWI | UWI xxx does not exist |
Fetch / Delete allocation | Unknown UWI | UWI xxx does not exist |