Skip to main content

Reset Lithology

Reset the lithology for a design to its default state. The existing formations are discarded and replaced with a single default Rock formation that spans from the seabed depth down to the deepest trajectory point (or collapses to the seabed depth if no trajectory exists).

Despite the DELETE verb, the lithology resource is not removed — every design always has a lithology. This endpoint clears any user-edited formations and restores the starting state.

DELETE/api/v1/designs/{designid}/lithology

Reset the lithology to a single default Rock formation

Path Parameters

NameTypeRequiredDescription
designidstring (UUID)The UUID of the design

Headers

NameValueDescription
apikeyYOUR_API_KEYYour API authentication key

What "reset" means

After a successful call the design's lithology contains exactly one formation:

FieldValue
formationType"Rock"
name"" (empty string)
topDepthTVDSeabed depth (water depth + drill-floor height) of the design
bottomDepthTVDDeepest trajectory TVD if a trajectory exists; otherwise equal to topDepthTVD

If the company's Formations library contains a Rock entry, the persisted row is enriched with that entry's density, specific heat, and thermal conductivity. Otherwise it is stored without those enrichments.

Notes

  • Returns 204 No Content on success — the response body is empty. Do not attempt to parse JSON from a 204 response.
  • The lithology resource itself is not removed; every design always has a lithology. This endpoint replaces the formations with the single default.
  • To verify the reset, call Fetch Lithology and confirm formations contains a single Rock entry.
  • To set a custom lithology with multiple formations, use Replace Lithology.