Skip to main content

Fetch Target

Retrieve a single target by its UUID. Returns the same fields as the list endpoint but scoped to one specific target — useful when you already know which target you need.

You can optionally control the depth reference of the returned values with the depthReference query parameter. If omitted, the target is returned in its stored reference type.

GET/api/v1/designs/{designid}/targets/{targetid}

Fetch a specific target by UUID

Path Parameters

NameTypeRequiredDescription
designidstring (UUID)The UUID of the design
targetidstring (UUID)The UUID of the target

Parameters

NameTypeRequiredDescription
depthReferencestring-Depth reference for returned values: 'RKB' or 'MSL'. Defaults to the target's stored reference.

Headers

NameValueDescription
apikeyYOUR_API_KEYYour API authentication key

Response fields

FieldTypeDescription
targetIdstring (UUID)Unique identifier of the target
namestringDisplay name
shapeobjectTarget shape — type plus optional parameters. See Create Target for the shape catalogue.
depthTVDstringTrue vertical depth, e.g. "2500|m"
depthReference"RKB" or "MSL"Depth reference datum
epsgCodestringCoordinate reference system, e.g. "EPSG:32633"
mapPositionEastingstringEasting on the projected map, e.g. "500000|m"
mapPositionNorthingstringNorthing on the projected map, e.g. "6000000|m"
geographicPositionLongitudeDDnumberLongitude in decimal degrees (read-only, computed server-side)
geographicPositionLatitudeDDnumberLatitude in decimal degrees (read-only, computed server-side)
geographicPositionLongitudeDMSstringLongitude in degrees/minutes/seconds (read-only)
geographicPositionLatitudeDMSstringLatitude in degrees/minutes/seconds (read-only)
azimuthstringOptional, e.g. "135|deg"
dipAnglestringOptional, e.g. "5|deg"
dipDirectionAzimuthstringOptional, e.g. "180|deg"
confidenceLevelstringOptional drillers-target confidence, e.g. "95|%"

Notes

  • The response includes rc: "ok" plus the target object's fields at the top level
  • Geographic position fields (geographicPosition*) are computed from the map position and the design's site coordinate system
  • For polygon targets, the position is carried by the polygon's points instead of mapPositionEasting/mapPositionNorthing
  • Useful for refreshing a single target after an edit, or for building a detail view