Skip to main content

Create String

Add a new casing or tubing string to an existing section of a well schematic. Strings represent individual joints of pipe within a section, each with their own outer diameter, weight, grade, and depth interval.

The new string is inserted at the supplied index if given, otherwise appended to the end of the section's strings. When inserting a string between existing ones, the server automatically adjusts the neighbouring strings' top and base depths to keep the section contiguous.

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

Add a new string to a well-schematic section

Path Parameters

NameTypeRequiredDescription
designidstring (UUID)The UUID of the design
sectionidstring (UUID)The UUID of the section to add the string to

Headers

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

Request Body

String definition with depths, OD, weight, and grade

Request body fields

FieldTypeRequiredDescription
topMDRKBstringYesTop depth, e.g. "20|m"
baseMDRKBstringYesBase depth, e.g. "875|m"
odstringYesOuter diameter; must exist in the Oliasoft Casing library, e.g. "20|in"
nominalWeightstringYesNominal weight; must exist in the Casing library, e.g. "169|ppf"
gradestringYesMaterial grade; must exist in the Oliasoft Grades library, e.g. "K-55"
connectionstringNoConnection name; must exist in the Oliasoft Connectors / Connections library
indexnumberNoZero-based position within the section's strings array. Omit to append.
idstring (UUID)NoPre-assigned string identifier. Omit to let the server allocate one.

Insertion semantics

The server adjusts neighbouring strings to keep the section contiguous depending on where the new string is inserted:

  • Append (end of strings) — the previous last-string's baseMDRKB is updated to the new string's topMDRKB; the section's overall base depth is updated to the new string's baseMDRKB
  • Prepend (index 0) — the existing first string's topMDRKB is updated to the new string's baseMDRKB. For Liner and Screen sections, the section's top depth is also updated.
  • Middle insertion — the string above has its baseMDRKB set to the new string's topMDRKB; the string below has its topMDRKB set to the new string's baseMDRKB

Notes

  • All measurements must be unit-encoded strings, e.g. "875\|m", "20\|in", "169\|ppf"
  • The combination of od, nominalWeight, and grade must reference values that exist in the Casing and Grades libraries — otherwise validation fails
  • Audit-log entries are written for every string creation