Skip to main content

Create Survey Run

Create a new survey run for a design. A survey run represents measurements from a specific survey tool over a depth interval. Provide the tool name, survey points, and how the run ties on to the wellbore.

POST/api/v1/designs/{designid}/survey-runs

Create a new survey run with points and tie-on configuration

Path Parameters

NameTypeRequiredDescription
designidstring (UUID)The UUID of the design

Headers

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

Request Body

Survey run definition with points, tool, and tie-on configuration

Request body fields

FieldTypeRequiredDescription
namestringYesDisplay name for the survey run
pointsobjectYesSurvey measurements as headers + values table
tieOnType"surface" or "run"NoHow this run connects to the wellbore. Defaults to "surface".
tieOnRunUUIDstring (UUID)If tieOnType is "run"UUID of the parent survey run to tie on to
tieOnDepthstringIf tieOnType is "run"Depth at which to tie on, e.g. "1000|m"
surveyToolstringNoSurvey tool / error model name. Defaults to "MWD rev 4 ISCWSA".

Tie-on types explained

Surface tie-on — Use for the first survey run in a well. The run starts from the surface.

{
"tieOnType": "surface"
}

Run tie-on — Use for subsequent runs that continue from where a previous run ends. You must specify which run to tie to and at what depth.

{
"tieOnType": "run",
"tieOnRunUUID": "e6ccd40f-9562-4234-b0e1-281128286b17",
"tieOnDepth": "1000|m"
}

Notes

  • The referenced tieOnRunUUID must be an existing survey run on the same design
  • The survey tool must exist in the company's error model settings
  • Points need at minimum the three headers: depthMD, inclination, azimuth
  • You can include date and status headers for additional survey metadata