Create Design

Create a new design in the WellDesign system.

POST/api/v3/datasets

Creates a new design dataset

Parameters

Name	Type	Required	Description
groupid	number	✓	The ID of the group this design belongs to
name	string	✓	The name of the design
unitSystem	string	✓	The unit system ('NCS' or 'API')
wellConfiguration	string	✓	The well configuration type (e.g., 'onshore', 'offshore')
drillingUnit	string	✓	The drilling unit type ('semi_submersible', 'platform_jackup', 'tlp_hybrid', or 'land_rig')
groundElevation	object	✓	Ground elevation object with value and unit properties
drillFloorHeight	string	✓	Drill floor height in pipe-separated format '<value>|<unit>' (e.g., '25|m')
wellheadDepth	string	✓	Wellhead depth in pipe-separated format '<value>|<unit>' (e.g., '75|m')
category	string	✓	The design category ('Prototype', 'Actual', 'Planned', or 'Archived')

Headers

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

Request Body

Design configuration object

Request Body

Design Configuration

{
"groupid": 1,
"name": "API DESIGN TEST 22222",
"unitSystem": "NCS",
"wellConfiguration": "onshore",
"drillingUnit": "land_rig",
"groundElevation": {
  "value": 100,
  "unit": "m"
},
"drillFloorHeight": "25|m",
"wellheadDepth": "75|m",
"category": "Prototype"
}

Notes

• The API returns a datasetid and datasetuuid for the created design
• Design names must be unique within your organization
• The API key must have write permissions for designs
• The response includes a version hash and status code (rc: 'ok' indicates success)