Network Pipe Constraint
The Network Pipe Constraint table describes time-based constraints applied to pipe elements in a network, for network optimization and forecasting defaults.
Constraints apply from the last date they were set. For example, if a record is added with date 2023-01-01T00:00:00+0000 and maxOilRate set to 1200 STB/d, that constraint continues to apply until a future record sets a different value for maxOilRate.
A NULL value for a particular constraint makes that variable unconstrained. If different constraint variables change on different time horizons, take care when posting updates — it is easy to unintentionally reset a constraint with a NULL value.
The unique constraint on network pipe constraint entries is sourcePipeId + sourceId.
Variable | Data Type | Unit of Measure | Is Nullable? | Default Value | Description |
|---|---|---|---|---|---|
sourceNetworkId | String | - | No | - | Source ID of the Network HeaderNetwork Header |
sourcePipeId | String | - | No | - | Source ID of the Network Pipe DefinitionNetwork Pipe Definition the constraint applies to |
sourceId | String | - | No | - | Source ID for the pipe/date constraint. This sourceId enables upsert functionality from client source systems of record. |
date | DateTimeOffset | - | No | - | Date at which the constraint becomes applicable. Datetime offset (with timezone) in ISO 8601 format. Example: 2022-09-27T16:28:37+0000 |
maxPressure | Double | psig | Yes | - | Maximum pressure constraint |
minPressure | Double | psig | Yes | - | Minimum pressure constraint |
maxOilRate | Double | STB/d | Yes | - | Maximum oil rate constraint |
maxGasRate | Double | Mscf/d | Yes | - | Maximum gas rate constraint |
maxWaterRate | Double | STB/d | Yes | - | Maximum water rate constraint |
maxLiquidRate | Double | STB/d | Yes | - | Maximum liquid rate constraint |
maxCFactor | Double | - | Yes | - | Maximum C-factor (pipe roughness coefficient) |
Data Integrity Checks
Condition | Response |
|---|---|
Any non-nullable field is NULL or empty | Record Rejected |
(sourceNetworkId, sourcePipeId) does not match a Network Pipe Definition | Record Rejected |
Common Error Messages
API | Scenario | Error Response |
|---|---|---|
Add / Upsert constraint | Unknown network pipe | Network Pipe was not found for network xxx and pipe xxx |