Replace Well Schematic

Replace the entire well schematic for a design. This is a full overwrite — the supplied sections array replaces any existing schematic on the design.

Use this endpoint to seed a brand-new design with its initial casing scheme, or to perform a bulk rewrite. For incremental changes prefer the section, string, and packer endpoints.

PUT/api/v1/designs/{designid}/well-schematic

Replace the well schematic for the design with the supplied sections

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

Full well schematic with at least one section

Request body fields

Field	Type	Required	Description
id	string (UUID)	No	Existing well schematic identifier (optional; ignored on replace)
sections	array	Yes	Ordered list of sections, top-down. Minimum 1 entry.

Section object

Field	Type	Required	Description
id	string (UUID)	No	Existing section ID. Omit to let the server assign one.
type	string	Yes	One of Casing, Liner, Tieback, Tubing, Screen, OpenHole
parameters	object	Yes	Type-specific parameters — see Create Section for the required fields per type
index	number	No	Position of the section in the schematic (top-down). Defaults to insertion order.

Notes

• This is a destructive replace — anything not in the supplied sections array is removed
• All measurements must be unit-encoded strings, e.g. "3500\|m", "9.625\|in", "1.05\|sg"
• The supplied sections are validated against the section-specific schema before being persisted
• An audit-log entry is written with a diff of the old vs new schematic