Skip to main content

Update Design

Update an existing design dataset in the WellDesign system.

PUT/api/v3/datasets

Update an existing design dataset's configuration

Parameters

NameTypeRequiredDescription
datasetUUIDstringThe UUID of the dataset to update
namestring-The new name of the design
wellConfigurationstring-The well configuration type (e.g., 'onshore', 'offshore')
drillingUnitstring-The drilling unit type ('semi_submersible', 'platform_jackup', 'tlp_hybrid', or 'land_rig')
groundElevationstring-Ground elevation in pipe-separated format '<value>|<unit>' (e.g., '456|m')
drillFloorHeightstring-Drill floor height in pipe-separated format '<value>|<unit>'
wellheadDepthstring-Wellhead depth in pipe-separated format '<value>|<unit>'
categorystring-The design category ('Prototype', 'Actual', 'Planned', or 'Archived')

Headers

NameValueDescription
apikeyYOUR_API_KEYYour API authentication key
Content-Typeapplication/jsonMust be application/json

Request Body

Dataset object with fields to update

Request Body

Update Dataset Configuration

{
"datasetUUID": "6e9ba2b2-5164-49f5-8233-1f0d329239d8",
"name": "Change Name23",
"category": "Actual",
"wellConfiguration": "onshore",
"drillingUnit": "land_rig",
"groundElevation": "456|m",
"drillFloorHeight": "456|m",
"wellheadDepth": "456|m"
}

Notes

  • The datasetUUID must be included in the request body to identify which dataset to update
  • All other fields are optional — only include what you want to change
  • Dataset names must be unique within your organization
  • The API returns the dataset ID, UUID, and status information
  • Ground elevation, drill floor height, and wellhead depth use pipe-separated format for value and unit