Edit String

Update an existing string within a section. All fields are optional — include only what you want to change. You can also reposition the string within its section by supplying index.

The path parameter stringid is the zero-based index of the string within the section's strings array, not a UUID.

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

Update fields on an existing string within 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 parent section
stringid	string (numeric index)	✓	Zero-based position of the string within the section's strings array

Headers

Name	Value	Description
apikey	YOUR_API_KEY	Your API authentication key
Content-Type	application/json	Must be application/json

Request Body

Partial string fields — at least one

Request body fields

All fields are optional, but at least one must be present.

Field	Type	Description
topMDRKB	string	Top depth, e.g. "20|m"
baseMDRKB	string	Base depth
od	string	Outer diameter; must exist in the Casing library
nominalWeight	string	Nominal weight; must exist in the Casing library
grade	string	Material grade; must exist in the Grades library
connection	string	Connection name; must exist in the Connectors library
index	number	New zero-based position within the section

Reorder semantics

Supplying index moves the string to that position within the section. The server automatically:

• adjusts the previous-position neighbours' depths to close the gap
• adjusts the new-position neighbours' depths to absorb the moved string
• for Liner / Screen sections, updates the section's top depth when the string moves to index 0
• updates the section's base depth and (if linked) hole depth when the string moves to the end

Notes

• stringid is the index, not a UUID. After a delete or insert the indices may shift.
• All measurements must be unit-encoded strings, e.g. "880\|m", "20\|in"
• Audit-log entries record the diff between the previous and updated string