Create Section
Add a new section (casing, liner, tieback, tubing, screen, or open hole) to a design's well schematic. The new section is inserted at the supplied index if given, otherwise appended to the end of the schematic.
The shape of parameters depends on the section type. See the Section types table below for the required and optional fields for each type.
Add a new section to the well schematic
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
designid | string (UUID) | ✓ | The UUID of the design |
Headers
| Name | Value | Description |
|---|---|---|
apikey | YOUR_API_KEY | Your API authentication key |
Content-Type | application/json | Must be application/json |
Request Body
Section definition — type, parameters, and optional index
Request body fields
| Field | Type | Required | Description |
|---|---|---|---|
type | string | Yes | One of Casing, Liner, Tieback, Tubing, Screen, OpenHole |
parameters | object | Yes | Type-specific parameter object — see below |
index | number | No | Zero-based position at which to insert the new section. Omit to append. |
id | string (UUID) | No | Pre-assigned section identifier. Omit to let the server allocate one. |
Section types
The parameters object depends on the section type.
Casing
| Field | Type | Required | Description |
|---|---|---|---|
tubularType | string | Yes | One of Conductor, Surface, Intermediate, Production |
holeSize | string | Yes | Hole size, must exist in the Hole Sizes library, e.g. "26|in" |
drillingFluidDensity | string | Yes | Drilling fluid density, e.g. "1.1|sg" |
strings | array | Yes | Minimum 1 string (see String fields) |
topOfCementMDRKB | string | Yes when tubularType is not Conductor | Top of cement, e.g. "20|m" |
sectionTotalDepthMDRKB | string | No | Section total depth, e.g. "900|m" |
leadCementSlurryDensity | string | No | Lead-slurry density |
tailCementSlurryDensity | string | Required if tailCementSlurryLength is set | Tail-slurry density |
tailCementSlurryLength | string | No | Tail-slurry length |
cementingFloatDepth | string | No | Cementing float depth |
displacementFluidDensity | string | No | Displacement-fluid density |
packers | array | No | Optional packers (see Packer fields) |
Liner
Same shape as Casing, except topOfCementMDRKB is always required (regardless of tubularType).
Tieback
| Field | Type | Required | Description |
|---|---|---|---|
tubularType | string | Yes | Must be Intermediate or Production |
completionFluidDensity | string | Yes | Completion-fluid density, e.g. "1.05|sg" |
strings | array | Yes | Minimum 1 string |
topOfCementMDRKB | string | No | Optional cement top |
leadCementSlurryDensity | string | No | Optional |
tailCementSlurryDensity | string | Required if tailCementSlurryLength is set | Optional |
tailCementSlurryLength | string | No | Optional |
cementingFloatDepth | string | No | Optional |
displacementFluidDensity | string | No | Optional |
isAnchored | boolean | No | Whether the tieback is anchored |
packers | array | No | Optional packers |
Tubing
| Field | Type | Required | Description |
|---|---|---|---|
completionFluidDensity | string | Yes | Completion-fluid density |
strings | array | Yes | Minimum 1 string |
packers | array | No | Optional packers |
Screen
| Field | Type | Required | Description |
|---|---|---|---|
holeSize | string | Yes | Hole size |
drillingFluidDensity | string | Yes | Drilling-fluid density |
strings | array | Yes | Minimum 1 string |
sectionTotalDepthMDRKB | string | No | Section total depth |
packers | array | No | Optional packers |
OpenHole
| Field | Type | Required | Description |
|---|---|---|---|
holeSize | string | Yes | Hole size |
holeDepthMDRKB | string | Yes | Hole depth |
drillingFluidDensity | string | Yes | Drilling-fluid density |
OpenHole sections do not have strings or packers.
String fields
Strings supplied inline in parameters.strings use the same shape as the Create String endpoint:
| Field | Type | Required | Description |
|---|---|---|---|
topMDRKB | string | Yes | Top depth, e.g. "20|m" |
baseMDRKB | string | Yes | Base depth |
od | string | Yes | Outer diameter; must exist in the Casing library, e.g. "20|in" |
nominalWeight | string | Yes | Nominal weight; must exist in the Casing library, e.g. "169|ppf" |
grade | string | Yes | Material grade; must exist in the Grades library, e.g. "K-55" |
connection | string | No | Connection name from the Connectors library |
index | number | No | Position of the string within the section |
Notes
- The server validates the section's
parametersagainst the type-specific schema before persisting - When the supplied
indexfalls outside the existing section range, the section is appended to the end - Audit-log entries are written for every section creation