Network Header
The Network Header defines a network of wells, sources, pipes, and compressors. Both the sourceId and the name must be globally unique — one network record exists per sourceId, and re-posting the same sourceId upserts it.
Variable | Data Type | Unit of Measure | Is Nullable? | Default Value | Description |
|---|---|---|---|---|---|
sourceId | String | - | No | - | Source ID for the network header. This sourceId enables upsert functionality from client source systems of record. |
name | String | - | No | - | Network name. Must be unique across all networks and should be descriptive for end users. |
date | DateTimeOffset | - | No | - | Date at which the network becomes valid. Datetime offset (with timezone) in ISO 8601 format. |
description | String | - | No | - | Description to contextualize the network (max 500 characters) |
type | String | - | No | - | Network type: PRODUCTION INJECTION |
Data Integrity Checks
Condition | Response |
|---|---|
Any non-nullable field is NULL or empty | Record Rejected |
name duplicates another network's name | Record Rejected |
type is not PRODUCTION or INJECTION | Record Rejected |
description exceeds 500 characters | Record Rejected |
Common Error Messages
API | Scenario | Error Response |
|---|---|---|
Fetch / Delete network | Unknown sourceId | Network with sourceId xxx does not exist |