Skip to main content

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.

POST/api/v1/designs/{designid}/well-schematic/sections

Add a new section to the well schematic

Path Parameters

NameTypeRequiredDescription
designidstring (UUID)The UUID of the design

Headers

NameValueDescription
apikeyYOUR_API_KEYYour API authentication key
Content-Typeapplication/jsonMust be application/json

Request Body

Section definition — type, parameters, and optional index

Request body fields

FieldTypeRequiredDescription
typestringYesOne of Casing, Liner, Tieback, Tubing, Screen, OpenHole
parametersobjectYesType-specific parameter object — see below
indexnumberNoZero-based position at which to insert the new section. Omit to append.
idstring (UUID)NoPre-assigned section identifier. Omit to let the server allocate one.

Section types

The parameters object depends on the section type.

Casing

FieldTypeRequiredDescription
tubularTypestringYesOne of Conductor, Surface, Intermediate, Production
holeSizestringYesHole size, must exist in the Hole Sizes library, e.g. "26|in"
drillingFluidDensitystringYesDrilling fluid density, e.g. "1.1|sg"
stringsarrayYesMinimum 1 string (see String fields)
topOfCementMDRKBstringYes when tubularType is not ConductorTop of cement, e.g. "20|m"
sectionTotalDepthMDRKBstringNoSection total depth, e.g. "900|m"
leadCementSlurryDensitystringNoLead-slurry density
tailCementSlurryDensitystringRequired if tailCementSlurryLength is setTail-slurry density
tailCementSlurryLengthstringNoTail-slurry length
cementingFloatDepthstringNoCementing float depth
displacementFluidDensitystringNoDisplacement-fluid density
packersarrayNoOptional packers (see Packer fields)

Liner

Same shape as Casing, except topOfCementMDRKB is always required (regardless of tubularType).

Tieback

FieldTypeRequiredDescription
tubularTypestringYesMust be Intermediate or Production
completionFluidDensitystringYesCompletion-fluid density, e.g. "1.05|sg"
stringsarrayYesMinimum 1 string
topOfCementMDRKBstringNoOptional cement top
leadCementSlurryDensitystringNoOptional
tailCementSlurryDensitystringRequired if tailCementSlurryLength is setOptional
tailCementSlurryLengthstringNoOptional
cementingFloatDepthstringNoOptional
displacementFluidDensitystringNoOptional
isAnchoredbooleanNoWhether the tieback is anchored
packersarrayNoOptional packers

Tubing

FieldTypeRequiredDescription
completionFluidDensitystringYesCompletion-fluid density
stringsarrayYesMinimum 1 string
packersarrayNoOptional packers

Screen

FieldTypeRequiredDescription
holeSizestringYesHole size
drillingFluidDensitystringYesDrilling-fluid density
stringsarrayYesMinimum 1 string
sectionTotalDepthMDRKBstringNoSection total depth
packersarrayNoOptional packers

OpenHole

FieldTypeRequiredDescription
holeSizestringYesHole size
holeDepthMDRKBstringYesHole depth
drillingFluidDensitystringYesDrilling-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:

FieldTypeRequiredDescription
topMDRKBstringYesTop depth, e.g. "20|m"
baseMDRKBstringYesBase depth
odstringYesOuter diameter; must exist in the Casing library, e.g. "20|in"
nominalWeightstringYesNominal weight; must exist in the Casing library, e.g. "169|ppf"
gradestringYesMaterial grade; must exist in the Grades library, e.g. "K-55"
connectionstringNoConnection name from the Connectors library
indexnumberNoPosition of the string within the section

Notes

  • The server validates the section's parameters against the type-specific schema before persisting
  • When the supplied index falls outside the existing section range, the section is appended to the end
  • Audit-log entries are written for every section creation