Network Screw Compressor Curve
The Network Screw Compressor Curve table describes time-based screw compressor performance curves applied to compressor elements in a network, for network optimization and forecasting.
The unique constraint on network screw compressor curve entries is sourceCompressorId + sourceId + date.
Variable | Data Type | Unit of Measure | Is Nullable? | Default Value | Description |
|---|---|---|---|---|---|
sourceNetworkId | String | - | No | - | Source ID of the Network HeaderNetwork Header |
sourceCompressorId | String | - | No | - | Source ID of the Network Compressor DefinitionNetwork Compressor Definition the curve applies to |
sourceId | String | - | No | - | Source ID for the compressor/date curve. This sourceId enables upsert functionality from client source systems of record. |
date | DateTimeOffset | - | No | - | Date at which the compressor curve becomes applicable. Datetime offset (with timezone) in ISO 8601 format. Example: 2022-09-27T16:28:37+0000 |
isActive | Bool | - | Yes | True | Whether this is the active compressor curve for the sourceCompressorId |
compressorCurve | List<object> | see below | No | - | Curve points — see the object description below |
Compressor Curve Notes
The compressorCurve object describes suction pressures and gas rates at defined discharge pressure steps. Each element carries one discharge pressure with parallel lists of suction pressures, gas rates, and fuel gas fractions (all three lists must be the same length).
Units of measure: pressures in psig, gas rate in Mscf/d, fuel gas in decimal percent.
[
{
"dischargePressure": 100,
"suctionPressure": [10, 20, 30],
"gasRate": [100, 200, 300],
"fuelGas": [0.2, 0.33, 0.23]
},
{
"dischargePressure": 200,
"suctionPressure": [15, 25, 35],
"gasRate": [105, 205, 305],
"fuelGas": [0.2, 0.33, 0.23]
}
]Data Integrity Checks
Condition | Response |
|---|---|
Any non-nullable field is NULL or empty | Record Rejected |
sourceNetworkId does not match a Network Header | Record Rejected |
(sourceNetworkId, sourceCompressorId) does not match a Network Compressor Definition | Record Rejected |
Common Error Messages
API | Scenario | Error Response |
|---|---|---|
Add / Upsert curve | Unknown sourceNetworkId | Unable to find network for source id xxx |
Add / Upsert curve | Unknown compressor | We did not find a compressor for network xxx and compressor xxx |