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
| Name | Type | Required | Description |
|---|---|---|---|
designid | string (UUID) | ✓ | The UUID of the design |
sectionid | string (UUID) | ✓ | The UUID of the section to add the string to |
Headers
| Name | Value | Description |
|---|---|---|
apikey | YOUR_API_KEY | Your API authentication key |
Content-Type | application/json | Must be application/json |
Request Body
String definition with depths, OD, weight, and grade
Request body fields
| Field | Type | Required | Description |
|---|---|---|---|
topMDRKB | string | Yes | Top depth, e.g. "20|m" |
baseMDRKB | string | Yes | Base depth, e.g. "875|m" |
od | string | Yes | Outer diameter; must exist in the Oliasoft 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 Oliasoft Grades library, e.g. "K-55" |
connection | string | No | Connection name; must exist in the Oliasoft Connectors / Connections library |
index | number | No | Zero-based position within the section's strings array. Omit to append. |
id | string (UUID) | No | Pre-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
baseMDRKBis updated to the new string'stopMDRKB; the section's overall base depth is updated to the new string'sbaseMDRKB - Prepend (index 0) — the existing first string's
topMDRKBis updated to the new string'sbaseMDRKB. ForLinerandScreensections, the section's top depth is also updated. - Middle insertion — the string above has its
baseMDRKBset to the new string'stopMDRKB; the string below has itstopMDRKBset to the new string'sbaseMDRKB
Notes
- All measurements must be unit-encoded strings, e.g.
"875\|m","20\|in","169\|ppf" - The combination of
od,nominalWeight, andgrademust reference values that exist in the Casing and Grades libraries — otherwise validation fails - Audit-log entries are written for every string creation