Network Joint Constraint
The Network Joint Constraint table describes time-based constraints applied to joint 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 joint constraint entries is sourceNetworkId + sourceId.
Variable | Data Type | Unit of Measure | Is Nullable? | Default Value | Description |
|---|---|---|---|---|---|
sourceNetworkId | String | - | No | - | Source ID of the Network HeaderNetwork Header |
sourceId | String | - | No | - | Source ID of the joint. Must match a joint sourceId defined as an upstream or downstream sourceId of a Network Pipe DefinitionNetwork Pipe Definition. |
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 |
maxMolarFractionCO2 | Double | molar fraction | Yes | - | Maximum molar fraction CO2 constraint |
maxMolarFractionN2 | Double | molar fraction | Yes | - | Maximum molar fraction N2 constraint |
maxMolarFractionH2S | Double | molar fraction | Yes | - | Maximum molar fraction H2S 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 |
Data Integrity Checks
Condition | Response |
|---|---|
Any non-nullable field is NULL or empty | Record Rejected |
sourceNetworkId does not match a Network Header | Record Rejected |
Common Error Messages
API | Scenario | Error Response |
|---|---|---|
Add / Upsert constraint | Unknown sourceNetworkId | Network was not found for source id xxx |