Fetch Well Schematic

Retrieve the full well schematic for a design. The well schematic is an ordered list of sections (casings, liners, tiebacks, tubings, screens, and open holes), each containing its strings and optional packers.

The response shape mirrors the body of the Replace Well Schematic endpoint, with computed values populated from the dataset.

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

Get the complete well schematic for a design

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

Response shape

Field	Type	Description
sections	array	Ordered list of well-schematic sections, top-down
sections[].id	string (UUID)	Section identifier
sections[].type	string	One of Casing, Liner, Tieback, Tubing, Screen, OpenHole
sections[].parameters	object	Type-specific parameters (see section type docs)
sv	string	Server version
rc	string	Response code (ok on success)

Section types

Each section's parameters payload depends on its type:

Type	Description
Casing	Cemented surface, intermediate, or production casing with strings and optional packers
Liner	Hung liner with cement parameters and strings
Tieback	Tieback to a previous liner; intermediate or production tubular
Tubing	Production tubing with strings and optional packers
Screen	Sand-control screen across reservoir
OpenHole	Open hole interval (no strings)

See the Create Section endpoint for the full parameter shape per section type.

Notes

• Returns 404 if the design exists but has no well schematic configured
• All measurements are returned as unit-encoded strings, e.g. "3500\|m", "9.625\|in", "1.05\|sg"
• Strings are listed in order from top to base