Skip to main content

Fetch data by data type

Retrieve data for a specific data type within the current design context.
Returns all data of the specified type from the active design.

GET/api/object/{dataType}

Retrieves data for a specific data type. The data type must be one of the supported types listed below.

Parameters

NameTypeRequiredDescription
dataTypestringThe data type to retrieve (e.g., PorePressureP50, TrajectoryPlan)

Supported Data Types

The following data types are supported by this endpoint:

Data TypeDescription
ProjectDataProject-level metadata and configuration
CoordinateReferenceSystemCoordinate system definitions
WellboreWellheadPositionWellhead position coordinates
PorePressureP10Pore pressure P10 (10th percentile)
PorePressureP50Pore pressure P50 (median)
PorePressureP90Pore pressure P90 (90th percentile)
FracturePressureP10Fracture pressure P10
FracturePressureP50Fracture pressure P50
FracturePressureP90Fracture pressure P90
CollapsePressureP10Collapse pressure P10
CollapsePressureP50Collapse pressure P50
CollapsePressureP90Collapse pressure P90
MinimumHorizontalStressPressureP10Minimum horizontal stress P10
MinimumHorizontalStressPressureP50Minimum horizontal stress P50
MinimumHorizontalStressPressureP90Minimum horizontal stress P90
TemperatureDefinitionTemperature profile definition
TemperatureListingTemperature data listing
TrajectoryPlanPlanned well trajectory
SurveyRunSurvey run data
DefinitiveSurveyDefinitionDefinitive survey definition
DefinitiveSurveyRunDefinitive survey run data
IPMFileIPM (Industry Planning Model) file data
PositionalUncertaintyListPositional uncertainty data
UncertaintyVectorsUncertainty vector definitions
GeomagneticParametersGeomagnetic field parameters
CovarianceMatrixCovariance matrix data

Notes

  • The data type parameter is case-sensitive and must match exactly as listed above
  • This endpoint returns data for the currently active design context
  • Each data type may have different data structures in the response
  • Pressure-related data types typically include depthTVD, gradient, and value fields
  • Survey and trajectory data types may have more complex structures specific to their purpose