API

Sources

Ingest sources

cognite.well_model.client.api.sources.SourcesAPI.ingest(self, sources: List[Source]) SourceList

Ingest sources

Remember to set merge rules after you have added any new sources.

Parameters

sources (List[Source]) –

Return type

SourceList

Examples

Ingest a source:
>>> from cognite.well_model import CogniteWellsClient
>>> from cognite.well_model.models import Source
>>> wm = CogniteWellsClient()
>>> source = Source(name="volve", description="My new source")
>>> response = wm.sources.ingest([source])

List sources

cognite.well_model.client.api.sources.SourcesAPI.list(self) SourceList

List sources

Return type

SourceList

Wells

Ingest wells

cognite.well_model.client.api.wells.WellsAPI.ingest(self, ingestions: List[WellIngestion]) WellList

Ingest wells

Parameters

ingestions (List[WellIngestion]) – List of WellIngestions

Returns

List of wells

Return type

List[Well]

List and filter wells

cognite.well_model.client.api.wells.WellsAPI.list(self, string_matching: Optional[str] = None, quadrants: Union[None, PropertyFilterNotSet, List[str]] = None, regions: Union[None, PropertyFilterNotSet, List[str]] = None, blocks: Union[None, PropertyFilterNotSet, List[str]] = None, fields: Union[None, PropertyFilterNotSet, List[str]] = None, operators: Union[None, PropertyFilterNotSet, List[str]] = None, sources: Optional[List[str]] = None, water_depth: Optional[DistanceRange] = None, datum: Optional[DistanceRange] = None, spud_date: Optional[DateRange] = None, well_types: Union[None, PropertyFilterNotSet, List[str]] = None, licenses: Union[None, PropertyFilterNotSet, List[str]] = None, trajectories: Optional[WellTrajectoryFilter] = None, depth_measurements: Optional[WellDepthMeasurementFilter] = None, time_measurements: Optional[WellTimeMeasurementFilter] = None, npt: Optional[WellNptFilter] = None, nds: Optional[WellNdsFilter] = None, polygon: Optional[PolygonFilter] = None, output_crs: Optional[str] = None, well_tops: Optional[WellTopFilter] = None, hole_sections: Optional[WellHoleSectionFilter] = None, casings: Optional[WellCasingFilter] = None, data_availability: Optional[WellDataAvailabilityFilter] = None, limit: Optional[int] = 100) WellList

Get wells that matches the filter

The result of this request is a list of wells with wellbores. If you are filtering only on well data, then each well in the response will contain all its wellbores. However, if you are filtering on wellbore data (trajectories, depth and time measurements, npt, nds, and well tops), then each well will only contain the wellbores that matched the request.

Parameters
  • string_matching (Optional[str], optional) – Fuzzy match on description and name.

  • quadrants (List[str] | NotSet, optional) – List of quadrants or NotSet

  • regions (List[str] | NotSet, optional) – List of regions or NotSet

  • blocks (List[str] | NotSet, optional) – List of blocks or NotSet

  • fields (List[str] | NotSet, optional) – List of fields or NotSet

  • operators (List[str] | NotSet, optional) – List of operators or NotSet

  • sources (Optional[List[str]], optional) – List of sources on wells

  • water_depth (Optional[DistanceRange], optional) –

  • datum – Optional[DistanceRange] optional,: Distance range for datum of the wells

  • spud_date (Optional[DateRange], optional) –

  • well_types (List[str] | NotSet, optional) – List of well types or NotSet

  • licenses (List[str] | NotSet, optional) – List of licenses or NotSet

  • trajectories (Optional[WellTrajectoryFilter], optional) –

  • depth_measurements (Optional[WellDepthMeasurementFilter], optional) – Filter wellbores which have measurements in certain depths.

  • time_measurements (Optional[WellTimeMeasurementFilter], optional) –

  • npt (Optional[WellNptFilter], optional) –

  • nds (Optional[WellNdsFilter], optional) –

  • polygon (Optional[PolygonFilter], optional) –

  • output_crs (Optional[str], optional) – The CRS you want the wellheads to be in. Default=EPSG:4326 (WGS84)

  • well_tops (Optional[WellTopFilter], optional) –

  • hole_sections (Optional[WellHoleSectionFilter], optional) – Filter wellsbores on hole section properties.

  • casings (Optional[WellCasingFilter], optional) – Filter wellsbores on casing properties.

  • data_availability (Optional[WellDataAvailabilityFilter], optional) – Filter wellsbores on data available for given data types.

  • limit (Optional[int], optional) – Max number of wells to retrieve. Defaults to 100.

Returns

List of wells

Return type

WellList

Examples

Get all wells
>>> from cognite.well_model import CogniteWellsClient
>>> wm = CogniteWellsClient()
>>> wells = wm.wells.list()
Get wells within a polygon
>>> from cognite.well_model import CogniteWellsClient
>>> from cognite.well_model.models import PolygonFilter
>>> wm = CogniteWellsClient()
>>> polygon = "POLYGON((3.4 60.7,6.08 57.44,1.16 58.44,3.40 60.7))"
>>> wells = wm.wells.list(polygon=PolygonFilter(
...     geometry=polygon,
...     crs="EPSG:4326",
...     geometry_type="WKT",
... ))
Get wells without a block
>>> from cognite.well_model import CogniteWellsClient, NotSet
>>> wm = CogniteWellsClient()
>>> wells = wm.wells.list(blocks=NotSet)
Get wells with gamma ray measurements between 500 and 1000 feet
>>> from cognite.well_model import CogniteWellsClient, NotSet
>>> from cognite.well_model.models import (
...     ContainsAllOrAny,
...     DistanceRange,
...     WellDepthMeasurementFilter,
... )
>>> wm = CogniteWellsClient()
>>> wells = wm.wells.list(depth_measurements=WellDepthMeasurementFilter(
...     measured_depth=DistanceRange(unit="foot", min=500.0, max=1000.0),
...     measurement_types=ContainsAllOrAny(
...         contains_any=["gamma ray"]
...     )
... ))
Get wellbores from wells list
>>> from cognite.well_model import CogniteWellsClient
>>> from cognite.well_model.models import WellNdsFilter
>>> wm = CogniteWellsClient()
>>> wells = wm.wells.list(nds = WellNdsFilter())
>>> wellbores = wells.wellbores()
Get wells with at least one of the data types present in data_availability
>>> from cognite.well_model import CogniteWellsClient
>>> wm = CogniteWellsClient()
>>> wm.experimental.enable()
>>> data_availability_filter = WellDataAvailabilityFilter(contains_any=["timeMeasurements", "npt", "nds"])
>>> wells = wm.wells.list(data_availability=data_availability_filter)

List incomplete wells

cognite.well_model.client.api.wells.WellsAPI.list_incomplete(self, limit: Optional[int] = 100) IncompleteWellList

Lists wells that are not complete and don’t have any wellhead information.

Parameters

limit (Optional[int], optional) – Max number of wells to retrieve. Defaults to 100.

Returns

List of incomplete wells

Return type

IncompleteWellList

Examples

List all incomplete wells
>>> from cognite.well_model import CogniteWellsClient
>>> wm = CogniteWellsClient()
>>> incomplete_wells = wm.wells.list_incomplete(limit=None)

Delete wells

cognite.well_model.client.api.wells.WellsAPI.delete(self, well_sources: List[AssetSource], recursive: bool = False)

Delete wells. If recursive is set to false, it will fail if a well has attached wellbores. If recursive is set to true, it will delete the well along with all its wellbores.

NOTE that the delete endpoint operates on WellIngestions and not Wells. If a well well-1 is comprised of two well ingestions EDM:well-1 and WITSML:well-1, then deleting EDM:well-1 will not touch anything ingested under WITSML:well-1.

Parameters
  • well_sources (List[AssetSource]) – List of well sources.

  • recursive (bool, optional) – [description]. Defaults to False. If the well has any wellbores, this flag must be set to true to delete it.

Examples

Delete a well
>>> from cognite.well_model import CogniteWellsClient
>>> from cognite.well_model.models import AssetSource
>>> wm = CogniteWellsClient()
>>> asset_source = AssetSource(asset_external_id="EDM:well-1", source_name="EDM")
>>> wm.wells.delete([asset_source], recursive=True)  

Retrieve a single well

cognite.well_model.client.api.wells.WellsAPI.retrieve(self, asset_external_id: Optional[str] = None, matching_id: Optional[str] = None, output_crs: Optional[str] = None) Well

Get well by asset external id or matching id

Parameters
  • asset_external_id (str, optional) –

  • matching_id (str, optional) –

  • output_crs – (str, optional) Specifies crs type for wellhead coordinates

Return type

Well

Raises

CogniteAPIError – If well is not found

Examples

Get well by asset external id
>>> from cognite.well_model import CogniteWellsClient
>>> wm = CogniteWellsClient()
>>> well = wm.wells.retrieve(asset_external_id="EDM:15/9-F-15")
Get well by matching_id
>>> from cognite.well_model import CogniteWellsClient
>>> wm = CogniteWellsClient()
>>> well = wm.wells.retrieve(matching_id="15/9-F-15")

Retrieve multiple wells

cognite.well_model.client.api.wells.WellsAPI.retrieve_multiple(self, asset_external_ids: Optional[List[str]] = None, matching_ids: Optional[List[str]] = None, output_crs: Optional[str] = None) WellList

Get wells by a list of asset external ids and matching ids

Parameters
  • asset_external_ids – list of well asset external ids

  • matching_ids – List of well matching ids

  • output_crs – str Specifies crs type for wellhead coordinates

Returns

List of wells

Return type

List[Well]

Set well merge rules

cognite.well_model.client.api.merge_rules.wells.WellMergeRulesAPI.set(self, rules: Union[WellMergeRules, List[str]]) WellMergeRules

Retrieve well merge rules

cognite.well_model.client.api.merge_rules.wells.WellMergeRulesAPI.retrieve(self) WellMergeRules

Retrieve merge details for a single well

cognite.well_model.client.api.wells.WellsAPI.merge_details(self, asset_external_id: Optional[str] = None, matching_id: Optional[str] = None) Optional[WellMergeDetailResource]

Retrieve merge details for a well

Parameters
  • asset_external_id (str, optional) –

  • matching_id (str, optional) –

Returns

merge details if the well exists.

Return type

Optional[WellMergeDetailResource]

Examples

Get merge details for a single well
>>> from cognite.well_model import CogniteWellsClient
>>> wm = CogniteWellsClient()
>>> details = wm.wells.merge_details(matching_id="15/9-F-15")
Get merge details for a single well using a Well object
>>> from cognite.well_model import CogniteWellsClient
>>> wm = CogniteWellsClient()
>>> details = wm.wells.retrieve(matching_id="15/9-F-15").merge_details()

Retrieve merge details for multiple wells

cognite.well_model.client.api.wells.WellsAPI.merge_details_multiple(self, asset_external_ids: Optional[List[str]] = None, matching_ids: Optional[List[str]] = None, ignore_unknown_ids: Optional[bool] = False) WellMergeDetailList

Retrieve merge details for multiple wells

Parameters
  • asset_external_ids – list of well asset external ids.

  • matching_ids – List of well matching ids.

  • ignore_unknown_ids (Optional[bool]) – If set to True, it will ignore unknown wells.

Returns

List-like object of merge details

Return type

WellMergeDetailList

Examples

Get merge details for a single well
>>> from cognite.well_model import CogniteWellsClient
>>> wm = CogniteWellsClient()
>>> details = wm.wells.merge_details_multiple(matching_ids=["15/9-F-15"])

Retrieve wellheads

cognite.well_model.client.api.wells.WellsAPI.wellheads(self, limit: Optional[int] = 100) WellWellheadViewList

Retrieve Wellheads view for all wells

Parameters

limit (Optional[int], optional) – [description]. Defaults to DEFAULT_LIMIT. use None to get all items.

Returns

a list of all WellWellheadViews in the project.

Return type

WellWellheadViewList

Examples

Get all wellheadsviews in the project
>>> from cognite.well_model import CogniteWellsClient
>>> wm = CogniteWellsClient()
>>> well_wellhead_views = wm.wells.wellheads(limit=None)

Wellbores

Ingest wellbores

cognite.well_model.client.api.wellbores.WellboresAPI.ingest(self, ingestions: List[WellboreIngestion]) WellboreList

Ingest wellbores

Parameters

ingestions (List[WellboreIngestion]) –

Return type

WellboreList

Retrieve a single wellbore

cognite.well_model.client.api.wellbores.WellboresAPI.retrieve(self, asset_external_id: Optional[str] = None, matching_id: Optional[str] = None) Wellbore

Get wellbore by asset external id or matching id.

Parameters
  • asset_external_id (Optional[str], optional) –

  • matching_id (Optional[str], optional) –

Return type

Wellbore

Retrieve multiple wellbores

cognite.well_model.client.api.wellbores.WellboresAPI.retrieve_multiple(self, asset_external_ids: Optional[List[str]] = None, matching_ids: Optional[List[str]] = None, ignore_unknown_ids: bool = False) WellboreList

Get wellbores by a list assets external ids and matching ids

Parameters
  • asset_external_ids (Optional[List[str]]) – list of wellbore asset external ids

  • matching_ids (Optional[List[str]]) – List of wellbore matching ids

  • ignore_unknown_ids (bool) – Set to true to ignore wellbores that aren’t found.

Return type

WellboreList

Set wellbore merge rules

cognite.well_model.client.api.merge_rules.wellbores.WellboreMergeRulesAPI.set(self, rules: Union[WellboreMergeRules, List[str]]) WellboreMergeRules

Retrieve wellbore merge rules

cognite.well_model.client.api.merge_rules.wellbores.WellboreMergeRulesAPI.retrieve(self) WellboreMergeRules

Retrieve merge details for a single wellbore

cognite.well_model.client.api.wellbores.WellboresAPI.merge_details(self, asset_external_id: Optional[str] = None, matching_id: Optional[str] = None) Optional[WellboreMergeDetailResource]

Retrieve merge details for a wellbore

Parameters
  • asset_external_id (str, optional) –

  • matching_id (str, optional) –

Returns

merge details if the wellbore exists.

Return type

Optional[WellboreMergeDetailResource]

Examples

Get merge details for a single wellbore
>>> from cognite.well_model import CogniteWellsClient
>>> wm = CogniteWellsClient()
>>> details = wm.wellbores.merge_details(matching_id="11/5-F-5")
Get merge details for a Wellbore object
>>> from cognite.well_model import CogniteWellsClient
>>> wm = CogniteWellsClient()
>>> details = wm.wellbores.retrieve(matching_id="11/5-F-5").merge_details()

Retrieve merge details for multiple wellbores

cognite.well_model.client.api.wellbores.WellboresAPI.merge_details_multiple(self, asset_external_ids: Optional[List[str]] = None, matching_ids: Optional[List[str]] = None, ignore_unknown_ids: Optional[bool] = False) WellboreMergeDetailList

Retrieve merge details for multiple wellbores

Parameters
  • asset_external_ids – list of wellbore asset external ids.

  • matching_ids – List of wellbore matching ids.

  • ignore_unknown_ids (Optional[bool]) – If set to True, it will ignore unknown wells.

Returns

List-like object of merge details

Return type

WellboreMergeDetailList

Examples

Get merge details for a single well
>>> from cognite.well_model import CogniteWellsClient
>>> wm = CogniteWellsClient()
>>> details = wm.wellbores.merge_details_multiple(matching_ids=["11/5-F-5"])

Trajectories

Ingest Trajectories

cognite.well_model.client.api.trajectories.TrajectoriesAPI.ingest(self, ingestions: List[TrajectoryIngestion]) TrajectoryList

Ingest trajectories

Parameters

ingestions (List[TrajectoryIngestion]) – List of trajectory ingestion objects

Return type

TrajectoryList

List trajectories

cognite.well_model.client.api.trajectories.TrajectoriesAPI.list(self, wellbore_asset_external_ids: Optional[List[str]] = None, wellbore_matching_ids: Optional[List[str]] = None, is_definitive: Optional[bool] = None, limit: Optional[int] = 100) TrajectoryList

List trajectories

Parameters
  • wellbore_asset_external_ids (Optional[List[str]], optional) –

  • wellbore_matching_ids (Optional[List[str]], optional) –

  • is_definitive (Optional[bool], optional) – If true, only return definitive trajectories. If false, only return non-definitive trajectories.

  • limit (Optional[int], optional) –

Return type

TrajectoryList

Examples

Retrieve definitive trajectory for a wellbore:
>>> from cognite.well_model import CogniteWellsClient
>>> wm = CogniteWellsClient()
>>> trajectories = wm.trajectories.list(
...    is_definitive=True,
...    wellbore_asset_external_ids=["VOLVE:13/10-F-11 T2"]
... )

Get trajectory data

cognite.well_model.client.api.trajectories.TrajectoriesAPI.list_data(self, sequence_external_id: str, measured_depth: Optional[DistanceRange] = None, true_vertical_depth: Optional[DistanceRange] = None) TrajectoryRows

Get trajectory data

Parameters
  • sequence_external_id (str) – External id of a sequence ingested as a trajectory

  • measured_depth (Optional[DistanceRange]) – MD range

  • true_vertical_depth (Optional[DistanceRange]) – TVD range

Returns

Trajectory and iterator over rows

Return type

TrajectoryRows

Interpolate (convert from MD to TVD)

cognite.well_model.client.api.trajectories.TrajectoriesAPI.interpolate(self, measured_depths: List[float], measured_depth_unit: str = 'meter', true_vertical_depth_unit: str = 'meter', *, wellbore_matching_id: Optional[str] = None, wellbore_asset_external_id: Optional[str] = None, ignore_unknown_measured_depths: Optional[bool] = False) TrueVerticalDepthList

Get the true vertical depth corresponding to a list of measured depths

The interpolation uses the minimum curvature method between trajectory points.

Parameters
  • measured_depths (List[float]) – List of measured depths.

  • measured_depth_unit (str, optional) – Unit for the measured depths. Defaults to “meter”.

  • true_vertical_depth_unit (str, optional) – Unit for the returned true vertical depths. Defaults to “meter”.

  • wellbore_matching_id (str, optional) –

  • wellbore_asset_external_id (str, optional) –

  • ignore_unknown_measured_depths (bool, optional) – set to True to ignore measured depths that are outside the trajectory

Returns

A list of true vertical depths corresponding to the given measured depths.

Return type

TrueVerticalDepthList

Examples

Interpolate measured depths
>>> from cognite.well_model import CogniteWellsClient
>>> wm = CogniteWellsClient()
>>> tvds = wm.trajectories.interpolate(
...     wellbore_asset_external_id="VOLVE:13/10-F-11 T2",
...     measured_depths=[100.0, 150.0, 200.0, 250.0]
... )
>>> tvds.true_vertical_depths
[100.0, 150.0, 200.0, 250.0]
Detect unknown depth
>>> from cognite.well_model import CogniteWellsClient
>>> wm = CogniteWellsClient()
>>> unreasonably_deep = 1000000000000000.0
>>> tvds = wm.trajectories.interpolate(
...     wellbore_asset_external_id="VOLVE:13/10-F-11 T2",
...     measured_depths=[100.0, 150.0, 200.0, 250.0, unreasonably_deep],
...     ignore_unknown_measured_depths=True,
... )
>>> unreasonably_deep in tvds.measured_depths
False
>>> # tvds.find(unreasonably_deep) will Raise a ValueError
>>> tvds.find(200.0)
200.0

Delete trajectories

cognite.well_model.client.api.trajectories.TrajectoriesAPI.delete(self, source_external_ids: List[str]) List[str]

Delete trajectories

Parameters

source_external_ids (List[str]) – List of external ids for a source for trajectory

Returns

List of external ids for a source for deleted trajectory

Return type

List[str]

Depth measurements

Ingest depth measurements

cognite.well_model.client.api.depth_measurements.DepthMeasurementsAPI.ingest(self, measurements: List[DepthMeasurementIngestion]) DepthMeasurementList

Ingest depth measurements

Parameters

measurements (List[DepthMeasurementIngestion]) –

Return type

DepthMeasurementList

List depth measurements

cognite.well_model.client.api.depth_measurements.DepthMeasurementsAPI.list(self, wellbore_asset_external_ids: Optional[List[str]] = None, wellbore_matching_ids: Optional[List[str]] = None, measurement_types: Optional[List[str]] = None, hole_sections: Optional[DepthMeasurementHoleSectionFilter] = None, well_tops: Optional[List[str]] = None, limit: Optional[int] = 100) DepthMeasurementList

List depth measurements

Parameters
  • wellbore_asset_external_ids (Optional[List[str]], optional) –

  • wellbore_matching_ids (Optional[List[str]], optional) –

  • measurement_types (Optional[List[str]], optional) – Only get measurements with any of these measurement types.

  • hole_sections (Optional[DepthMeasurementHoleSectionFilter], optional) – Only get Depth Measurements that have values within a hole section with given properties.

  • well_tops (Optional[List[str]], optional) – EXPERIMENTAL Only get Depth Measurements that penetrate any of the given surfaces. Supports up to 10 well top names.

  • limit (Optional[int], optional) –

Return type

DepthMeasurementList

Retrieve a single depth measurement

cognite.well_model.client.api.depth_measurements.DepthMeasurementsAPI.retrieve(self, sequence_external_id: str) Optional[DepthMeasurement]

Retrieve a single depth measurement by sequence external id

Parameters

sequence_external_id (str) – Sequence external id

Returns

DepthMeasurement if found, else None.

Return type

Optional[DepthMeasurement]

Examples

Retrieve a depth measurement
>>> from cognite.well_model import CogniteWellsClient
>>> wm = CogniteWellsClient()
>>> measurement = wm.depth_measurements.retrieve("VOLVE:seq1")

Retrieve multiple depth measurements

cognite.well_model.client.api.depth_measurements.DepthMeasurementsAPI.retrieve_multiple(self, sequence_external_ids: List[str], ignore_unknown_ids=False) DepthMeasurementList

Retrieve multiple depth measurements by sequence external ids.

Parameters
  • sequence_external_ids (List[str]) – List of sequence external ids.

  • ignore_unknown_ids (bool, optional) – Ignore unknown ids. Defaults to False.

Returns

List of matching depth measurements

Return type

DepthMeasurementList

Examples

Retrieve two depth measurements
>>> from cognite.well_model import CogniteWellsClient
>>> wm = CogniteWellsClient()
>>> measurements = wm.depth_measurements.retrieve_multiple([
...    "VOLVE:seq1",
...    "VOLVE:seq2"
... ])
>>> len(measurements)
2

List data from depth measurements

cognite.well_model.client.api.depth_measurements.DepthMeasurementsAPI.list_data(self, sequence_external_id: str, measured_depth: Optional[DistanceRange] = None, depth_unit: Optional[DistanceUnit] = None, measurement_types: Optional[List[str]] = None, column_external_ids: Optional[List[str]] = None, top_surface_name: Optional[str] = None, limit: int = 100) DepthMeasurementRows

Get depth measurement data

NB! For now it is not supported to filter on both measurement types and column external ids in the same query.

Parameters
  • sequence_external_id (str) – Sequence external id

  • measured_depth (Optional[DistanceRange], optional) – MD range

  • depth_unit (Optional[DistanceUnit], optional) – Unit and factor for MD measurement

  • measurement_types (Optional[List[str]], optional) – This decides which columns you will download.

  • column_external_ids (Optional[List[str]], optional) – This decides which columns you will download.

  • top_surface_name (Optional[str], optional) – If set, only get the rows inside the range defined by the top surface.

  • limit (int, optional) – Max number of rows to get. Defaults to DEFAULT_LIMIT.

Returns

Depth measurement with data. An iterator over rows.

Return type

DepthMeasurementRows

Examples

Get depth measurement data
>>> from cognite.well_model import CogniteWellsClient
>>> wm = CogniteWellsClient()
>>> data = wm.depth_measurements.list_data(
...     sequence_external_id="VOLVE:seq1"
... )
>>> df = data.to_pandas()
Get depth measurement data using .data()
>>> from cognite.well_model import CogniteWellsClient
>>> wm = CogniteWellsClient()
>>> depth_measurement = wm.depth_measurements.list()[0]
>>> data = depth_measurement.data()
>>> df = data.to_pandas()
Get depth measurement data in MD range

Only get the rows between 150.0 and 500.0 meters MD

>>> from cognite.well_model import CogniteWellsClient
>>> wm = CogniteWellsClient()
>>> depth_measurement = wm.depth_measurements.list()[0]
>>> data = depth_measurement.data(
...     measured_depth={
...         "min": 150.0,
...         "max": 500.0,
...         "unit": "meter",
...     }
... )
Get only gamma ray measurements
>>> from cognite.well_model import CogniteWellsClient
>>> wm = CogniteWellsClient()
>>> data = wm.depth_measurements.list_data(
...     sequence_external_id="VOLVE:seq1",
...     measurement_types=["gamma ray"],
... )
>>> df = data.to_pandas()
Get only RMED measurements
>>> from cognite.well_model import CogniteWellsClient
>>> wm = CogniteWellsClient()
>>> data = wm.depth_measurements.list_data(
...     sequence_external_id="VOLVE:seq1",
...     column_external_ids=["RMED"],
... )
>>> df = data.to_pandas()
Filter and retrieve only gamma ray measurements
>>> from cognite.well_model import CogniteWellsClient
>>> wm = CogniteWellsClient()
>>> depth_measurements = wm.depth_measurements.list(
...     measurement_types=["gamma ray"]
... )
>>> dm = depth_measurements[0]
>>> # Will only retrieve the "gamma ray" columns.
>>> data = dm.data(measurement_types=["gamma ray"])

Delete depth measurements

cognite.well_model.client.api.depth_measurements.DepthMeasurementsAPI.delete(self, source_external_ids: List[str]) List[str]

Delete depth measurements

Parameters

source_external_ids (List[str]) – List of external ids for sources to depth measurements to be deleted

Returns

List of external ids for deleted depth measurements.

Return type

List[str]

Time measurements

Ingest time measurements

cognite.well_model.client.api.time_measurements.TimeMeasurementsAPI.ingest(self, measurements: List[TimeMeasurement]) TimeMeasurementList

Ingests time measurements

Parameters

measurements (List[TimeMeasurement]) –

Returns

List of ingested measurements

Return type

TimeMeasurementList

List time measurements

cognite.well_model.client.api.time_measurements.TimeMeasurementsAPI.list(self, wellbore_asset_external_ids: Optional[List[str]] = None, wellbore_matching_ids: Optional[List[str]] = None, measurement_types: Optional[List[str]] = None, limit: Optional[int] = 100) TimeMeasurementList

List time measurements

Parameters
  • wellbore_asset_external_ids (Optional[List[str]], optional) –

  • wellbore_matching_ids (Optional[List[str]], optional) –

  • measurement_types (Optional[List[str]], optional) –

  • limit (Optional[int], optional) –

Return type

TimeMeasurementList

Delete time measurements

cognite.well_model.client.api.time_measurements.TimeMeasurementsAPI.delete(self, external_ids: List[str]) List[str]

Delete time measurements

Parameters

external_ids (List[str]) – List of external ids for time measurements

Returns

List of external ids for deleted time measurements.

Return type

List[str]

Summaries

Well types

cognite.well_model.client.api.summaries.SummariesAPI.welltypes(self) SummaryList

Get all well types

Returns

list of well types

Return type

SummaryList

Datum

cognite.well_model.client.api.summaries.SummariesAPI.datum(self) DistanceRange

Get a range of minimum and maximum datum

Returns

A range value for minimum and maximum datum

Return type

DistanceRange

Measurement types

cognite.well_model.client.api.summaries.SummariesAPI.measurement_types(self) List[MeasurementType]

Get all active measurement types

Returns

A list of measurement types that are in use

Return type

List[MeasurementType]

NPT codes

cognite.well_model.client.api.summaries.SummariesAPI.npt_codes(self) SummaryList

Get all Npt codes

Returns

list of Npt codes

Return type

SummaryList

NPT detail codes (deprecated)

cognite.well_model.client.api.summaries.SummariesAPI.npt_detail_codes(self) SummaryList

Get all NPT detail codes (deprecated: Use npt_code_details instead)

Returns

list of Npt detail codes

Return type

SummaryList

NPT code details

cognite.well_model.client.api.summaries.SummariesAPI.npt_code_details(self) SummaryList

Get all NPT code_detail’s

Returns

list of Npt code_detail’s.

Return type

SummaryList

NPT durations

cognite.well_model.client.api.summaries.SummariesAPI.npt_durations(self) DurationRange

Get the minimum and maximum NPT duration

Returns

describing min and max duration

Return type

DurationRange

NDS risk types

cognite.well_model.client.api.summaries.SummariesAPI.nds_risk_types(self) SummaryList

Get all Nds risk types

Returns

list of Nds risk types

Return type

SummaryList

Measured depth on trajectories

cognite.well_model.client.api.summaries.SummariesAPI.trajectories_measured_depth(self) DistanceRange

Get a range of minimum and maximum measured depth on trajectories

Returns

a range representing minimum and maximum measured depth

Return type

DistanceRange

True vertical depth on trajectories

cognite.well_model.client.api.summaries.SummariesAPI.trajectories_true_vertical_depth(self) DistanceRange

Get a range of minimum and maximum true vertical depth on trajectories

Returns

a range representing minimum and maximum true vertical depth

Return type

DistanceRange

Dogleg severity on trajectories

cognite.well_model.client.api.summaries.SummariesAPI.trajectories_dogleg_severity(self) DoglegSeverityRange

Get a range of minimum and maximum dogleg severity on trajectories

Returns

a range representing minimum and maximum dogleg severity

Return type

DoglegSeverityRange

Maximum inclination on trajectories

cognite.well_model.client.api.summaries.SummariesAPI.trajectories_inclination(self) AngleRange

Get a range of minimum and maximum value for maximum inclination angle on trajectories

Returns

a range representing minimum and maximum value for maximum inclination angle

Return type

AngleRange

Well properties

cognite.well_model.client.api.summaries.SummariesAPI.well_properties(self, types: List[WellPropertiesEnum]) WellPropertiesList

Get aggregated well properties.

Send in a list of aggregation criteria’s, and get wells grouped by the criterias.

Parameters

types (List[WellPropertiesEnum]) – [description]

Returns

[description]

Return type

WellPropertiesList

Examples
Group by region and field
>>> from cognite.well_model import CogniteWellsClient
>>> wm = CogniteWellsClient()
>>> groups = wm.summaries.well_properties(["region", "field"])
>>> groups.to_pandas()
      region     field  wellsCount
0  North Sea   ALVHEIM           3
1  North Sea  SLEIPNER           2
2  North Sea       NaN           1

Non-Productive Time (NPT) events

Ingest NPT events

cognite.well_model.client.api.npt_events.NptEventsAPI.ingest(self, npt_events: List[NptIngestion]) NptList

Ingest NPT events

Parameters

npt_events (List[NptIngestion]) –

Returns

Ingested NPT events

Return type

NptList

List NPT events

cognite.well_model.client.api.npt_events.NptEventsAPI.list(self, md: Optional[DistanceRange] = None, duration: Optional[DurationRange] = None, npt_codes: Union[None, PropertyFilterNotSet, List[str]] = None, npt_code_details: Union[None, PropertyFilterNotSet, List[str]] = None, root_causes: Union[None, PropertyFilterNotSet, List[str]] = None, locations: Union[None, PropertyFilterNotSet, List[str]] = None, subtypes: Union[None, PropertyFilterNotSet, List[str]] = None, wellbore_asset_external_ids: Optional[List[str]] = None, wellbore_matching_ids: Optional[List[str]] = None, limit: Optional[int] = 100) NptList

Get NPT events matching the arguments

Parameters
  • md (Optional[DistanceRange], optional) –

  • duration (Optional[DurationRange], optional) –

  • npt_codes (PropertyFilter, optional) – [description]. Defaults to None.

  • npt_code_details (PropertyFilter, optional) – [description]. Defaults to None.

  • root_causes (PropertyFilter, optional) – [description]. Defaults to None.

  • locations (PropertyFilter, optional) – [description]. Defaults to None.

  • subtypes (PropertyFilter, optional) – [description]. Defaults to None.

  • wellbore_asset_external_ids (Optional[List[str]], optional) – [description]. Defaults to None.

  • wellbore_matching_ids (Optional[List[str]], optional) – [description]. Defaults to None.

  • limit (Optional[int], optional) – [description]. Defaults to DEFAULT_LIMIT.

Returns

[description]

Return type

NptList

Examples

Get NPT events with npt_code set to None.
>>> from cognite.well_model import CogniteWellsClient, NotSet
>>> wm = CogniteWellsClient()
>>> npt_events = wm.npt.list(npt_codes=NotSet)
Get NPT events with npt_codes and wellbores
>>> from cognite.well_model import CogniteWellsClient, NotSet
>>> wm = CogniteWellsClient()
>>> npt_events = wm.npt.list(
...     npt_codes=["ABCD", "DEFG"],
...     wellbore_matching_ids=["13/10-F-11 T2"]
... )

Aggregate NPT events

cognite.well_model.client.api.npt_events.NptEventsAPI.aggregate(self, wellbore_asset_external_ids: Optional[List[str]] = None, wellbore_matching_ids: Optional[List[str]] = None, group_by: List[NptAggregateEnum] = []) NptAggregateList

Aggregate npt events for a list of wellbores

Parameters
  • wellbore_asset_external_ids (Optional[List[str]], optional) – List of wellbore asset external ids

  • wellbore_matching_ids (Optional[List[str]], optional) – List of wellbore matching ids.

  • group_by (List[NptAggregateEnum], optional) – List of aggregation types. Allowed values: “npt code” and “npt code detail”.

Returns

List of NPT aggregations

Return type

NptAggregateList

Examples

Aggregate NPT events over npt code:
>>> from cognite.well_model import CogniteWellsClient
>>> wm = CogniteWellsClient()
>>> aggregates = wm.npt.aggregate(
...     group_by=["npt code"],
...     wellbore_matching_ids=["13/10-F-11 T2"]
... )
>>> aggregates.to_pandas()
  wellboreMatchingId  duration durationUnit  count
0      13/10-F-11 T2      12.0         hour      3
>>> aggregates[0].to_pandas()
  wellboreMatchingId  count  duration durationUnit    nptCode
0      13/10-F-11 T2      2       8.0         hour   TESTCODE
1      13/10-F-11 T2      1       4.0         hour  TESTCODE4

Delete NPT events

cognite.well_model.client.api.npt_events.NptEventsAPI.delete(self, event_external_ids: List[str]) List[str]

Delete NPT events

Parameters

event_external_ids (List[str]) – List of external ids for NPT events.

Returns

List of external ids of deleted NPT events.

Return type

List[str]

No Drilling Surprise (NDS) events

Ingest NDS events

cognite.well_model.client.api.nds_events.NdsEventsAPI.ingest(self, nds_events: List[NdsIngestion]) NdsList

Ingest NDS events

Parameters

nds_events (List[NdsIngestion]) – list of Nds events to ingest

Return type

NdsList

Warning

NdsIngestion.hole_start is deprecated, use hole_top instead.

NdsIngestion.hole_end is deprecated, use hole_base instead.

List NDS events

cognite.well_model.client.api.nds_events.NdsEventsAPI.list(self, hole_start: Optional[DistanceRange] = None, hole_end: Optional[DistanceRange] = None, hole_top: Optional[DistanceRange] = None, hole_base: Optional[DistanceRange] = None, probabilities: Optional[List[int]] = None, severities: Optional[List[int]] = None, wellbore_asset_external_ids: Optional[List[str]] = None, wellbore_matching_ids: Optional[List[str]] = None, risk_types: Union[None, PropertyFilterNotSet, List[str]] = None, subtypes: Union[None, PropertyFilterNotSet, List[str]] = None, limit: Optional[int] = 100) NdsList

Get Nds events that matches the filter

Parameters
  • hole_start – Deprecated, use hole_top

  • hole_top – range of hole top in desired Nds events

  • hole_end – Deprecated, use hole_base

  • hole_base – range of base end in desired Nds events

  • probabilities – list of interested probabilities

  • severities – list of interested severities

  • wellbore_asset_external_ids – list of wellbore asset external ids

  • wellbore_matching_ids – list of wellbore matching ids

  • limit – optional limit. Set to None to get everything

Return type

NdsList

Warning

hole_start is deprecated, use hole_top instead.

hole_end is deprecated, use hole_base instead.

Aggregate NDS events

cognite.well_model.client.api.nds_events.NdsEventsAPI.aggregate(self, wellbore_asset_external_ids: Optional[List[str]] = None, wellbore_matching_ids: Optional[List[str]] = None, group_by: List[NdsAggregateEnum] = []) NdsAggregateList

Aggregate NDS events for a list of wellbores

Parameters
  • wellbore_asset_external_ids (Optional[List[str]], optional) – List of wellbore asset external ids

  • wellbore_matching_ids (Optional[List[str]], optional) – List of wellbore matching ids.

  • group_by (List[NdsAggregateEnum], optional) – List of aggregation types. Allowed values: severity, probability, risk type, subtype.

Returns

List of NDS aggregations

Return type

NdsAggregateList

Examples

Aggregate NDS events over severity:
>>> from cognite.well_model import CogniteWellsClient
>>> wm = CogniteWellsClient()
>>> aggregates = wm.nds.aggregate(
...     group_by=["severity"],
...     wellbore_matching_ids=["13/10-F-11 T2"]
... )
>>> aggregates.to_pandas()
  wellboreMatchingId  count
0      13/10-F-11 T2      3
>>> aggregates[0].to_pandas()
  wellboreMatchingId  count  severity
0      13/10-F-11 T2      1         3
1      13/10-F-11 T2      2         5

Delete NDS events

cognite.well_model.client.api.nds_events.NdsEventsAPI.delete(self, event_external_ids: List[str]) List[str]

Delete NPT events

Parameters

event_external_ids (List[str]) – List of external ids for NDS events

Returns

List of external ids for deleted NDS events

Return type

List[str]

Hole Sections

Ingest Hole Sections

cognite.well_model.client.api.hole_sections.HoleSectionsAPI.ingest(self, hole_sections: List[HoleSectionGroupIngestion]) HoleSectionGroupsList

Ingest hole sections

Parameters

hole_sections (List[HoleSectionGroupIngestion]) –

Return type

HoleSectionGroupsList

List Hole Sections

cognite.well_model.client.api.hole_sections.HoleSectionsAPI.list(self, wellbore_asset_external_ids: Optional[List[str]] = None, wellbore_matching_ids: Optional[List[str]] = None, bit_size: Optional[Distance] = None, hole_size: Optional[Distance] = None, top_measured_depth: Optional[DistanceRange] = None, base_measured_depth: Optional[DistanceRange] = None, start_time: Optional[TimeRange] = None, end_time: Optional[TimeRange] = None, is_definitive: Optional[bool] = None, limit: Optional[int] = 100) HoleSectionGroupsList

List hole sections

Parameters
  • wellbore_asset_external_ids (Optional[List[str]], optional) –

  • wellbore_matching_ids (Optional[List[str]], optional) –

  • limit (Optional[int], optional) – Max number of hole section groups to return.

  • bit_size (Optional[Distance]) – Bit size of a hole section,

  • hole_size (Optional[Distance]) – Hole size of a hole section,

  • top_measured_depth (Optional[DistanceRange]) – Shallowest point of a hole sections,

  • base_measured_depth (Optional[DistanceRange]) – Deepest point of a hole sections,

  • start_time (Optional[TimeRange]) – Start time for a hole section creation,

  • end_time (Optional[TimeRange]) – End time for a hole section creation,

  • is_definitive (Optional[bool]) – Specify if hole sections needs to be marked as definite or not, if not specified both definite and not definitive hole sections are returned,

Return type

HoleSectionGroupsList

Delete Hole Sections

cognite.well_model.client.api.hole_sections.HoleSectionsAPI.delete(self, external_ids: List[str]) List[str]

Delete Hole Section Groups

Parameters

external_ids (List[str]) – List of external ids for hole section groups to be deleted

Returns

List of external ids for deleted hole section groups.

Return type

List[str]

Casings

Ingest Casings

cognite.well_model.client.api.casings.CasingsAPI.ingest(self, casings: List[CasingSchematicIngestion]) CasingsList

Ingest casings

Parameters

casings (List[CasingSchematicIngestion]) –

Return type

CasingsList

Examples

Ingesting and delete a casing schematic with assemblies and components:
>>> from cognite.well_model import CogniteWellsClient
>>> from cognite.well_model.models import (
...     CasingAssembly,
...     CasingComponent,
...     CasingSchematicIngestion,
...     Distance,
...     LinearWeight,
...     LinearWeightUnit,
...     PhaseEnum,
...     SequenceSource,
... )
>>> wm = CogniteWellsClient()
>>> ingestion = CasingSchematicIngestion(
...     wellbore_asset_external_id="VOLVE:15/9-F-4",
...     source=SequenceSource(
...         sequence_external_id="VOLVE:casings-1",
...         source_name="VOLVE"
...     ),
...     phase=PhaseEnum.planned,
...     casing_assemblies=[
...         CasingAssembly(
...             min_inside_diameter=Distance(value=10, unit="inch"),
...             min_outside_diameter=Distance(value=11, unit="inch"),
...             max_outside_diameter=Distance(value=11, unit="inch"),
...             original_measured_depth_top=Distance(value=8826.79002, unit="foot"),
...             original_measured_depth_base=Distance(value=9687.0, unit="foot"),
...             type="conductor",
...             report_description="Drill Collar",
...             section_type_code="DC",
...             components=[
...                 CasingComponent(
...                     description="Drill Collar 6.5 in, , 105, 91.786",
...                     min_inside_diameter=Distance(value=6.5, unit="inch"),
...                     max_outside_diameter=Distance(value=6.5, unit="inch"),
...                     type_code="DC",
...                     top_measured_depth=Distance(value=8826.79002, unit="foot"),
...                     base_measured_depht=Distance(value=9687.0, unit="foot"),
...                     grade="C-90",
...                     connection_name="4 1/2 I",
...                     joints=2,
...                     manufacturer="BTS Ramco",
...
...                     # linear weight is 91.7 pounds/foot
...                     linear_weight=LinearWeight(
...                         value=91.786,
...                         unit=LinearWeightUnit(
...                             weight_unit="pound",
...                             depth_unit="foot"
...                         )
...                     )
...                 )
...             ]
...         )
...     ]
... )
>>> result = wm.casings.ingest([ingestion])
>>> # Delete the casing again
>>> _ = wm.casings.delete(["VOLVE:casings-1"])

List Casings

cognite.well_model.client.api.casings.CasingsAPI.list(self, wellbore_asset_external_ids: Optional[List[str]] = None, wellbore_matching_ids: Optional[List[str]] = None, limit: Optional[int] = 100) CasingsList

List casings

Parameters
  • wellbore_asset_external_ids (Optional[List[str]], optional) –

  • wellbore_matching_ids (Optional[List[str]], optional) –

  • limit (Optional[int], optional) – Max number of casings.

Return type

CasingsList

Delete Casings

cognite.well_model.client.api.casings.CasingsAPI.delete(self, source_external_ids: List[str]) List[str]

Delete casings

Parameters

source_external_ids (List[str]) – List of casing sources external ids

Returns

List of external ids for deleted casings.

Return type

List[str]

Well tops

Ingest Well tops

cognite.well_model.client.api.well_tops.WellTopsAPI.ingest(self, ingestions: List[WellTopsIngestion]) WellTopsList

Ingest well tops

Parameters

ingestions (List[WellTopsIngestion]) –

Return type

WellTopsList

Examples

Ingest well top with lithostratigraphic and chronostratigraphic
>>> from cognite.well_model import CogniteWellsClient
>>> from cognite.well_model.models import (
...     Chronostratigraphic,
...     Lithostratigraphic,
...     SequenceSource,
...     WellTopsIngestion,
...     WellTopSurfaceIngestion,
... )
>>> wm = CogniteWellsClient()
>>> ingestion = WellTopsIngestion(
...     wellbore_asset_external_id="VOLVE:15/9-F-15 B",
...     source=SequenceSource(
...         sequence_external_id="VOLVE:15/9-F-15 B/welltops", source_name="VOLVE"
...     ),
...     measured_depth_unit="meter",
...     tops=[
...         WellTopSurfaceIngestion(
...             name="NORDLAND GP",
...             top_measured_depth=106,
...             base_measured_depth=1108,
...             lithostratigraphic=Lithostratigraphic(level="group"),
...             # Since we are populating epoch, then period and era
...             # will be automatically set.
...             chronostratigraphic=Chronostratigraphic(epoch="miocene"),
...         ),
...         # ...
...     ],
... )
>>> tops = wm.well_tops.ingest([ingestion])

List Well tops

cognite.well_model.client.api.well_tops.WellTopsAPI.list(self, wellbore_asset_external_ids: Optional[List[str]] = None, wellbore_matching_ids: Optional[List[str]] = None, limit: Optional[int] = 100) WellTopsList

List well tops

Parameters
  • wellbore_asset_external_ids (Optional[List[str]], optional) –

  • wellbore_matching_ids (Optional[List[str]], optional) –

  • limit (Optional[int], optional) –

Returns

WellTopsList

Delete Well tops

cognite.well_model.client.api.well_tops.WellTopsAPI.delete(self, source_external_ids: List[str]) List[str]

Delete well tops

Parameters

source_external_ids (List[str]) – List of external ids for well tops

Returns

List of external ids for deleted well tops.

Return type

List[str]

Rig operations

Ingest Rig operations

cognite.well_model.client.api.rig_operations.RigOperationsAPI.ingest(self, rig_operations: List[RigOperationIngestion]) RigOperationList

Ingest Rig Operations

Parameters

rig_operations (List[RigOperationIngestion]) –

Returns

Ingested Rig Operations

Return type

RigOperationList

List Rig operations

cognite.well_model.client.api.rig_operations.RigOperationsAPI.list(self, rig_names: Optional[List[str]] = None, start_time: Optional[TimeRange] = None, end_time: Optional[TimeRange] = None, wellbore_asset_external_ids: Optional[List[str]] = None, wellbore_matching_ids: Optional[List[str]] = None, limit: Optional[int] = 100) RigOperationList

Get Rig Operations matching the arguments

Parameters
  • rig_names (Optional[List[str]], optional) –

  • start_time (Optional[TimeRange], optional) –

  • end_time (Optional[TimeRange], optional) –

  • wellbore_asset_external_ids (Optional[List[str]], optional) –

  • wellbore_matching_ids (Optional[List[str]], optional) –

  • limit (Optional[int], optional) –

Returns

List of matched Rig Operations

Return type

RigOperationList

Examples

Get Rig Operations with start_time.
>>> from cognite.well_model import CogniteWellsClient, NotSet
>>> wm = CogniteWellsClient()
>>> rig_operations = wm.rig_operations.list(
...     start_time=TimeRange(min=1609603200000, max=1609761600000)
... )
Get Rig Operations with rig_names and wellbores
>>> from cognite.well_model import CogniteWellsClient, NotSet
>>> wm = CogniteWellsClient()
>>> rig_operations = wm.rig_operations.list(
...     rig_names=["ABCD", "DEFG"],
...     wellbore_matching_ids=["13/10-F-11 T2"]
... )

Delete Rig operations

cognite.well_model.client.api.rig_operations.RigOperationsAPI.delete(self, external_ids: List[GeneralExternalId]) List[GeneralExternalId]

Delete Rig Operations

Parameters

external_ids (List[GeneralExternalId]) – List of external ids for Rig Operations.

Returns

List of external ids of deleted Rig Operations.

Return type

List[GeneralExternalId]

Measurement types

List measurement types

cognite.well_model.client.api.measurement_types.MeasurementTypesAPI.list(self, measurement_types: Optional[List[str]] = None) MeasurementTypeDetailsList

Get a list of measurement types details

Parameters

measurement_types (List[str]) – List of measurement types to be retrieved.

Returns

A list of measurement type details

Return type

List[MeasurementTypeDetails]

Examples

Get measurement types of type “gamma ray” and caliper
>>> from cognite.well_model import CogniteWellsClient
>>> wm = CogniteWellsClient()
>>> types = wm.measurement_types.list(["gamma ray", "caliper"])

Data classes

class cognite.well_model.CogniteWellsClient(api_key: Optional[str] = None, project: Optional[str] = None, client_name: Optional[str] = None, base_url: Optional[str] = None, max_workers: Optional[int] = None, headers: Optional[Dict[str, str]] = None, timeout: Optional[int] = None, token: Optional[Union[str, Callable[[], str]]] = None, token_url: Optional[str] = None, token_client_id: Optional[str] = None, token_client_secret: Optional[str] = None, token_scopes: Optional[List[str]] = None, token_custom_args: Optional[Dict[str, str]] = None)

All services are made available through this object. See examples below.

Parameters
  • api_key (str) – API key

  • project (str) – Project. Defaults to project of given API key.

  • client_name (str) – A user-defined name for the client. Used to identify number of unique applications/scripts running on top of CDF.

  • base_url (str) – Base url to send requests to.

  • max_workers (int) – Max number of workers to spawn when parallelizing data fetching. Defaults to 10.

  • headers (Dict) – Additional headers to add to all requests.

  • timeout (int) – Timeout on requests sent to the api. Defaults to 60 seconds.

  • token (Union[str, Callable]) – token (Union[str, Callable[[], str]]): A jwt or method which takes no arguments and returns a jwt to use for authentication.

  • token_url (str) – Optional url to use for token generation

  • token_client_id (str) – Optional client id to use for token generation.

  • token_client_secret (str) – Optional client secret to use for token generation.

  • token_scopes (list) – Optional list of scopes to use for token generation.

  • token_custom_args (Dict) – Optional additional arguments to use for token generation.

property config: ClientConfig

Configuration for the current client.

property experimental: Experimental

Experimental features configuration

pydantic model cognite.well_model.models.Angle

Show JSON schema
{
   "title": "Angle",
   "description": "Well data layer base model",
   "type": "object",
   "properties": {
      "value": {
         "title": "Value",
         "type": "number"
      },
      "unit": {
         "$ref": "#/definitions/AngleUnitEnum"
      }
   },
   "required": [
      "value",
      "unit"
   ],
   "definitions": {
      "AngleUnitEnum": {
         "title": "AngleUnitEnum",
         "description": "An enumeration.",
         "enum": [
            "degree",
            "radian"
         ],
         "type": "string"
      }
   }
}

Config
  • allow_population_by_field_name: bool = True

Fields
field unit: AngleUnitEnum [Required]
field value: float [Required]
pydantic model cognite.well_model.models.AngleRange

Show JSON schema
{
   "title": "AngleRange",
   "description": "Well data layer base model",
   "type": "object",
   "properties": {
      "unit": {
         "$ref": "#/definitions/AngleUnitEnum"
      },
      "min": {
         "title": "Min",
         "type": "number"
      },
      "max": {
         "title": "Max",
         "type": "number"
      }
   },
   "required": [
      "unit"
   ],
   "definitions": {
      "AngleUnitEnum": {
         "title": "AngleUnitEnum",
         "description": "An enumeration.",
         "enum": [
            "degree",
            "radian"
         ],
         "type": "string"
      }
   }
}

Config
  • allow_population_by_field_name: bool = True

Fields
field max: Optional[float] = None
field min: Optional[float] = None
field unit: AngleUnitEnum [Required]
class cognite.well_model.models.AngleUnitEnum(value)

An enumeration.

pydantic model cognite.well_model.models.AssetSource

Show JSON schema
{
   "title": "AssetSource",
   "description": "Well data layer base model",
   "type": "object",
   "properties": {
      "assetExternalId": {
         "title": "Assetexternalid",
         "description": "Asset external ID.",
         "type": "string"
      },
      "sourceName": {
         "title": "Sourcename",
         "description": "Name of the source this asset external ID belongs to.",
         "example": "EDM",
         "type": "string"
      }
   },
   "required": [
      "assetExternalId",
      "sourceName"
   ]
}

Config
  • allow_population_by_field_name: bool = True

Fields
field asset_external_id: str [Required] (alias 'assetExternalId')

Asset external ID.

field source_name: str [Required] (alias 'sourceName')

Name of the source this asset external ID belongs to.

pydantic model cognite.well_model.models.CasingAssembly

Show JSON schema
{
   "title": "CasingAssembly",
   "description": "Well data layer base model",
   "type": "object",
   "properties": {
      "minInsideDiameter": {
         "title": "Mininsidediameter",
         "description": "Minimum inside diameter of the casing assembly.",
         "allOf": [
            {
               "$ref": "#/definitions/Distance"
            }
         ]
      },
      "minOutsideDiameter": {
         "title": "Minoutsidediameter",
         "description": "Minimum outside diameter of the casing assembly.",
         "allOf": [
            {
               "$ref": "#/definitions/Distance"
            }
         ]
      },
      "maxOutsideDiameter": {
         "title": "Maxoutsidediameter",
         "description": "Maximum outside diameter of the casing assembly.",
         "allOf": [
            {
               "$ref": "#/definitions/Distance"
            }
         ]
      },
      "originalMeasuredDepthTop": {
         "title": "Originalmeasureddepthtop",
         "description": "measured depth top of the casing assembly. Must be less than or equal to originalMeasuredDepthBase.",
         "allOf": [
            {
               "$ref": "#/definitions/Distance"
            }
         ]
      },
      "originalMeasuredDepthBase": {
         "title": "Originalmeasureddepthbase",
         "description": "measured depth baes of the casing assembly. Must be larger than or equal to originalMeasuredDepthTop.",
         "allOf": [
            {
               "$ref": "#/definitions/Distance"
            }
         ]
      },
      "type": {
         "title": "Type",
         "description": "Type of casing assembly. Examples: Intermediate casing, production casing, production liner, etc.",
         "maxLength": 255,
         "type": "string"
      },
      "reportDescription": {
         "title": "Reportdescription",
         "description": "Report description of the casing assembly",
         "type": "string"
      },
      "sectionTypeCode": {
         "title": "Sectiontypecode",
         "maxLength": 50,
         "type": "string"
      },
      "components": {
         "title": "Components",
         "type": "array",
         "items": {
            "$ref": "#/definitions/CasingComponent"
         }
      }
   },
   "required": [
      "minInsideDiameter",
      "minOutsideDiameter",
      "maxOutsideDiameter",
      "originalMeasuredDepthTop",
      "originalMeasuredDepthBase"
   ],
   "definitions": {
      "DistanceUnitEnum": {
         "title": "DistanceUnitEnum",
         "description": "An enumeration.",
         "enum": [
            "meter",
            "foot",
            "inch",
            "yard"
         ],
         "type": "string"
      },
      "Distance": {
         "title": "Distance",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "value": {
               "title": "Value",
               "description": "Amount of a given unit.",
               "type": "number"
            },
            "unit": {
               "$ref": "#/definitions/DistanceUnitEnum"
            }
         },
         "required": [
            "value",
            "unit"
         ]
      },
      "WeightUnitEnum": {
         "title": "WeightUnitEnum",
         "description": "An enumeration.",
         "enum": [
            "kilogram",
            "pound"
         ],
         "type": "string"
      },
      "LinearWeightUnit": {
         "title": "LinearWeightUnit",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "weightUnit": {
               "$ref": "#/definitions/WeightUnitEnum"
            },
            "depthUnit": {
               "$ref": "#/definitions/DistanceUnitEnum"
            }
         },
         "required": [
            "weightUnit",
            "depthUnit"
         ]
      },
      "LinearWeight": {
         "title": "LinearWeight",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "value": {
               "title": "Value",
               "type": "number"
            },
            "unit": {
               "$ref": "#/definitions/LinearWeightUnit"
            }
         },
         "required": [
            "value",
            "unit"
         ]
      },
      "CasingComponent": {
         "title": "CasingComponent",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "minInsideDiameter": {
               "title": "Mininsidediameter",
               "description": "Minimum inside diameter of the casing component.",
               "allOf": [
                  {
                     "$ref": "#/definitions/Distance"
                  }
               ]
            },
            "maxOutsideDiameter": {
               "title": "Maxoutsidediameter",
               "description": "Maximum outside diameter of the casing component.",
               "allOf": [
                  {
                     "$ref": "#/definitions/Distance"
                  }
               ]
            },
            "topMeasuredDepth": {
               "title": "Topmeasureddepth",
               "description": "Top measured depth of the casing component. If both `baseMeasuredDepth` and `topMeasuredDepth` are set, then `baseMeasuredDepth` must be larger or equal to `topMeasuredDepth`.\n",
               "allOf": [
                  {
                     "$ref": "#/definitions/Distance"
                  }
               ]
            },
            "baseMeasuredDepth": {
               "title": "Basemeasureddepth",
               "description": "Base measured depth of the casing component. If both `baseMeasuredDepth` and `topMeasuredDepth` are set, then `baseMeasuredDepth` must be larger or equal to `topMeasuredDepth`.\n",
               "allOf": [
                  {
                     "$ref": "#/definitions/Distance"
                  }
               ]
            },
            "grade": {
               "title": "Grade",
               "description": "Classification of the material used in the casing component. For example L-80, or J-55.\n",
               "maxLength": 50,
               "example": "L-80",
               "type": "string"
            },
            "connectionName": {
               "title": "Connectionname",
               "description": "Name of the casing connection",
               "maxLength": 50,
               "type": "string"
            },
            "joints": {
               "title": "Joints",
               "description": "Number of component joints",
               "minimum": 1,
               "type": "integer"
            },
            "description": {
               "title": "Description",
               "description": "Casing component description",
               "maxLength": 255,
               "type": "string"
            },
            "manufacturer": {
               "title": "Manufacturer",
               "description": "Casing component manufacturer",
               "maxLength": 255,
               "type": "string"
            },
            "typeCode": {
               "title": "Typecode",
               "description": "Casing component type",
               "maxLength": 50,
               "type": "string"
            },
            "linearWeight": {
               "$ref": "#/definitions/LinearWeight"
            }
         }
      }
   }
}

Config
  • allow_population_by_field_name: bool = True

Fields
field components: Optional[List[CasingComponent]] = None
field max_outside_diameter: Distance [Required] (alias 'maxOutsideDiameter')

Maximum outside diameter of the casing assembly.

field min_inside_diameter: Distance [Required] (alias 'minInsideDiameter')

Minimum inside diameter of the casing assembly.

field min_outside_diameter: Distance [Required] (alias 'minOutsideDiameter')

Minimum outside diameter of the casing assembly.

field original_measured_depth_base: Distance [Required] (alias 'originalMeasuredDepthBase')

measured depth baes of the casing assembly. Must be larger than or equal to originalMeasuredDepthTop.

field original_measured_depth_top: Distance [Required] (alias 'originalMeasuredDepthTop')

measured depth top of the casing assembly. Must be less than or equal to originalMeasuredDepthBase.

field report_description: Optional[str] = None (alias 'reportDescription')

Report description of the casing assembly

field section_type_code: Optional[str] = None (alias 'sectionTypeCode')
Constraints
  • maxLength = 50

field type: Optional[str] = None

Type of casing assembly. Examples: Intermediate casing, production casing, production liner, etc.

Constraints
  • maxLength = 255

pydantic model cognite.well_model.models.CasingComponent

Show JSON schema
{
   "title": "CasingComponent",
   "description": "Well data layer base model",
   "type": "object",
   "properties": {
      "minInsideDiameter": {
         "title": "Mininsidediameter",
         "description": "Minimum inside diameter of the casing component.",
         "allOf": [
            {
               "$ref": "#/definitions/Distance"
            }
         ]
      },
      "maxOutsideDiameter": {
         "title": "Maxoutsidediameter",
         "description": "Maximum outside diameter of the casing component.",
         "allOf": [
            {
               "$ref": "#/definitions/Distance"
            }
         ]
      },
      "topMeasuredDepth": {
         "title": "Topmeasureddepth",
         "description": "Top measured depth of the casing component. If both `baseMeasuredDepth` and `topMeasuredDepth` are set, then `baseMeasuredDepth` must be larger or equal to `topMeasuredDepth`.\n",
         "allOf": [
            {
               "$ref": "#/definitions/Distance"
            }
         ]
      },
      "baseMeasuredDepth": {
         "title": "Basemeasureddepth",
         "description": "Base measured depth of the casing component. If both `baseMeasuredDepth` and `topMeasuredDepth` are set, then `baseMeasuredDepth` must be larger or equal to `topMeasuredDepth`.\n",
         "allOf": [
            {
               "$ref": "#/definitions/Distance"
            }
         ]
      },
      "grade": {
         "title": "Grade",
         "description": "Classification of the material used in the casing component. For example L-80, or J-55.\n",
         "maxLength": 50,
         "example": "L-80",
         "type": "string"
      },
      "connectionName": {
         "title": "Connectionname",
         "description": "Name of the casing connection",
         "maxLength": 50,
         "type": "string"
      },
      "joints": {
         "title": "Joints",
         "description": "Number of component joints",
         "minimum": 1,
         "type": "integer"
      },
      "description": {
         "title": "Description",
         "description": "Casing component description",
         "maxLength": 255,
         "type": "string"
      },
      "manufacturer": {
         "title": "Manufacturer",
         "description": "Casing component manufacturer",
         "maxLength": 255,
         "type": "string"
      },
      "typeCode": {
         "title": "Typecode",
         "description": "Casing component type",
         "maxLength": 50,
         "type": "string"
      },
      "linearWeight": {
         "$ref": "#/definitions/LinearWeight"
      }
   },
   "definitions": {
      "DistanceUnitEnum": {
         "title": "DistanceUnitEnum",
         "description": "An enumeration.",
         "enum": [
            "meter",
            "foot",
            "inch",
            "yard"
         ],
         "type": "string"
      },
      "Distance": {
         "title": "Distance",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "value": {
               "title": "Value",
               "description": "Amount of a given unit.",
               "type": "number"
            },
            "unit": {
               "$ref": "#/definitions/DistanceUnitEnum"
            }
         },
         "required": [
            "value",
            "unit"
         ]
      },
      "WeightUnitEnum": {
         "title": "WeightUnitEnum",
         "description": "An enumeration.",
         "enum": [
            "kilogram",
            "pound"
         ],
         "type": "string"
      },
      "LinearWeightUnit": {
         "title": "LinearWeightUnit",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "weightUnit": {
               "$ref": "#/definitions/WeightUnitEnum"
            },
            "depthUnit": {
               "$ref": "#/definitions/DistanceUnitEnum"
            }
         },
         "required": [
            "weightUnit",
            "depthUnit"
         ]
      },
      "LinearWeight": {
         "title": "LinearWeight",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "value": {
               "title": "Value",
               "type": "number"
            },
            "unit": {
               "$ref": "#/definitions/LinearWeightUnit"
            }
         },
         "required": [
            "value",
            "unit"
         ]
      }
   }
}

Config
  • allow_population_by_field_name: bool = True

Fields
field base_measured_depth: Optional[Distance] = None (alias 'baseMeasuredDepth')

Base measured depth of the casing component. If both baseMeasuredDepth and topMeasuredDepth are set, then baseMeasuredDepth must be larger or equal to topMeasuredDepth.

field connection_name: Optional[str] = None (alias 'connectionName')

Name of the casing connection

Constraints
  • maxLength = 50

field description: Optional[str] = None

Casing component description

Constraints
  • maxLength = 255

field grade: Optional[str] = None

Classification of the material used in the casing component. For example L-80, or J-55.

Constraints
  • maxLength = 50

field joints: Optional[int] = None

Number of component joints

Constraints
  • minimum = 1

field linear_weight: Optional[LinearWeight] = None (alias 'linearWeight')
field manufacturer: Optional[str] = None

Casing component manufacturer

Constraints
  • maxLength = 255

field max_outside_diameter: Optional[Distance] = None (alias 'maxOutsideDiameter')

Maximum outside diameter of the casing component.

field min_inside_diameter: Optional[Distance] = None (alias 'minInsideDiameter')

Minimum inside diameter of the casing component.

field top_measured_depth: Optional[Distance] = None (alias 'topMeasuredDepth')

Top measured depth of the casing component. If both baseMeasuredDepth and topMeasuredDepth are set, then baseMeasuredDepth must be larger or equal to topMeasuredDepth.

field type_code: Optional[str] = None (alias 'typeCode')

Casing component type

Constraints
  • maxLength = 50

pydantic model cognite.well_model.models.CasingFilter

Show JSON schema
{
   "title": "CasingFilter",
   "description": "Well data layer base model",
   "type": "object",
   "properties": {
      "wellboreIds": {
         "title": "Wellboreids",
         "minItems": 1,
         "maxItems": 1000,
         "type": "array",
         "items": {
            "$ref": "#/definitions/Identifier"
         }
      },
      "isDefinitive": {
         "title": "Isdefinitive",
         "description": "Specifies if the query is to return only definitive or not. If value is not set, then all casings are returned.",
         "type": "boolean"
      }
   },
   "definitions": {
      "Identifier": {
         "title": "Identifier",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "matchingId": {
               "title": "Matchingid",
               "description": "Matching id of a well or a wellbore.",
               "type": "string"
            },
            "assetExternalId": {
               "title": "Assetexternalid",
               "description": "Asset id of a well or a wellbore",
               "type": "string"
            }
         }
      }
   }
}

Config
  • allow_population_by_field_name: bool = True

Fields
field is_definitive: Optional[bool] = None (alias 'isDefinitive')

Specifies if the query is to return only definitive or not. If value is not set, then all casings are returned.

field wellbore_ids: Optional[List[Identifier]] = None (alias 'wellboreIds')
Constraints
  • minItems = 1

  • maxItems = 1000

pydantic model cognite.well_model.models.CasingFilterRequest

Show JSON schema
{
   "title": "CasingFilterRequest",
   "description": "Well data layer base model",
   "type": "object",
   "properties": {
      "limit": {
         "title": "Limit",
         "description": "Maximum number of rows returned in one request. If there is more data beyond this limit, a cursor will be returned to enable further fetching of data.",
         "minimum": 1,
         "maximum": 1000,
         "type": "integer"
      },
      "cursor": {
         "title": "Cursor",
         "description": "Cursor for pagination returned from a previous request. Apart from cursor and limit, the rest of the request object must be the same as for the original request.",
         "type": "string"
      },
      "filter": {
         "$ref": "#/definitions/CasingFilter"
      }
   },
   "definitions": {
      "Identifier": {
         "title": "Identifier",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "matchingId": {
               "title": "Matchingid",
               "description": "Matching id of a well or a wellbore.",
               "type": "string"
            },
            "assetExternalId": {
               "title": "Assetexternalid",
               "description": "Asset id of a well or a wellbore",
               "type": "string"
            }
         }
      },
      "CasingFilter": {
         "title": "CasingFilter",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "wellboreIds": {
               "title": "Wellboreids",
               "minItems": 1,
               "maxItems": 1000,
               "type": "array",
               "items": {
                  "$ref": "#/definitions/Identifier"
               }
            },
            "isDefinitive": {
               "title": "Isdefinitive",
               "description": "Specifies if the query is to return only definitive or not. If value is not set, then all casings are returned.",
               "type": "boolean"
            }
         }
      }
   }
}

Config
  • allow_population_by_field_name: bool = True

Fields
field filter: Optional[CasingFilter] = None
pydantic model cognite.well_model.models.CasingIngestionItems

Show JSON schema
{
   "title": "CasingIngestionItems",
   "description": "Well data layer base model",
   "type": "object",
   "properties": {
      "items": {
         "title": "Items",
         "minItems": 1,
         "maxItems": 1000,
         "type": "array",
         "items": {
            "$ref": "#/definitions/CasingSchematicIngestion"
         }
      }
   },
   "required": [
      "items"
   ],
   "definitions": {
      "DistanceUnitEnum": {
         "title": "DistanceUnitEnum",
         "description": "An enumeration.",
         "enum": [
            "meter",
            "foot",
            "inch",
            "yard"
         ],
         "type": "string"
      },
      "Distance": {
         "title": "Distance",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "value": {
               "title": "Value",
               "description": "Amount of a given unit.",
               "type": "number"
            },
            "unit": {
               "$ref": "#/definitions/DistanceUnitEnum"
            }
         },
         "required": [
            "value",
            "unit"
         ]
      },
      "WeightUnitEnum": {
         "title": "WeightUnitEnum",
         "description": "An enumeration.",
         "enum": [
            "kilogram",
            "pound"
         ],
         "type": "string"
      },
      "LinearWeightUnit": {
         "title": "LinearWeightUnit",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "weightUnit": {
               "$ref": "#/definitions/WeightUnitEnum"
            },
            "depthUnit": {
               "$ref": "#/definitions/DistanceUnitEnum"
            }
         },
         "required": [
            "weightUnit",
            "depthUnit"
         ]
      },
      "LinearWeight": {
         "title": "LinearWeight",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "value": {
               "title": "Value",
               "type": "number"
            },
            "unit": {
               "$ref": "#/definitions/LinearWeightUnit"
            }
         },
         "required": [
            "value",
            "unit"
         ]
      },
      "CasingComponent": {
         "title": "CasingComponent",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "minInsideDiameter": {
               "title": "Mininsidediameter",
               "description": "Minimum inside diameter of the casing component.",
               "allOf": [
                  {
                     "$ref": "#/definitions/Distance"
                  }
               ]
            },
            "maxOutsideDiameter": {
               "title": "Maxoutsidediameter",
               "description": "Maximum outside diameter of the casing component.",
               "allOf": [
                  {
                     "$ref": "#/definitions/Distance"
                  }
               ]
            },
            "topMeasuredDepth": {
               "title": "Topmeasureddepth",
               "description": "Top measured depth of the casing component. If both `baseMeasuredDepth` and `topMeasuredDepth` are set, then `baseMeasuredDepth` must be larger or equal to `topMeasuredDepth`.\n",
               "allOf": [
                  {
                     "$ref": "#/definitions/Distance"
                  }
               ]
            },
            "baseMeasuredDepth": {
               "title": "Basemeasureddepth",
               "description": "Base measured depth of the casing component. If both `baseMeasuredDepth` and `topMeasuredDepth` are set, then `baseMeasuredDepth` must be larger or equal to `topMeasuredDepth`.\n",
               "allOf": [
                  {
                     "$ref": "#/definitions/Distance"
                  }
               ]
            },
            "grade": {
               "title": "Grade",
               "description": "Classification of the material used in the casing component. For example L-80, or J-55.\n",
               "maxLength": 50,
               "example": "L-80",
               "type": "string"
            },
            "connectionName": {
               "title": "Connectionname",
               "description": "Name of the casing connection",
               "maxLength": 50,
               "type": "string"
            },
            "joints": {
               "title": "Joints",
               "description": "Number of component joints",
               "minimum": 1,
               "type": "integer"
            },
            "description": {
               "title": "Description",
               "description": "Casing component description",
               "maxLength": 255,
               "type": "string"
            },
            "manufacturer": {
               "title": "Manufacturer",
               "description": "Casing component manufacturer",
               "maxLength": 255,
               "type": "string"
            },
            "typeCode": {
               "title": "Typecode",
               "description": "Casing component type",
               "maxLength": 50,
               "type": "string"
            },
            "linearWeight": {
               "$ref": "#/definitions/LinearWeight"
            }
         }
      },
      "CasingAssembly": {
         "title": "CasingAssembly",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "minInsideDiameter": {
               "title": "Mininsidediameter",
               "description": "Minimum inside diameter of the casing assembly.",
               "allOf": [
                  {
                     "$ref": "#/definitions/Distance"
                  }
               ]
            },
            "minOutsideDiameter": {
               "title": "Minoutsidediameter",
               "description": "Minimum outside diameter of the casing assembly.",
               "allOf": [
                  {
                     "$ref": "#/definitions/Distance"
                  }
               ]
            },
            "maxOutsideDiameter": {
               "title": "Maxoutsidediameter",
               "description": "Maximum outside diameter of the casing assembly.",
               "allOf": [
                  {
                     "$ref": "#/definitions/Distance"
                  }
               ]
            },
            "originalMeasuredDepthTop": {
               "title": "Originalmeasureddepthtop",
               "description": "measured depth top of the casing assembly. Must be less than or equal to originalMeasuredDepthBase.",
               "allOf": [
                  {
                     "$ref": "#/definitions/Distance"
                  }
               ]
            },
            "originalMeasuredDepthBase": {
               "title": "Originalmeasureddepthbase",
               "description": "measured depth baes of the casing assembly. Must be larger than or equal to originalMeasuredDepthTop.",
               "allOf": [
                  {
                     "$ref": "#/definitions/Distance"
                  }
               ]
            },
            "type": {
               "title": "Type",
               "description": "Type of casing assembly. Examples: Intermediate casing, production casing, production liner, etc.",
               "maxLength": 255,
               "type": "string"
            },
            "reportDescription": {
               "title": "Reportdescription",
               "description": "Report description of the casing assembly",
               "type": "string"
            },
            "sectionTypeCode": {
               "title": "Sectiontypecode",
               "maxLength": 50,
               "type": "string"
            },
            "components": {
               "title": "Components",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/CasingComponent"
               }
            }
         },
         "required": [
            "minInsideDiameter",
            "minOutsideDiameter",
            "maxOutsideDiameter",
            "originalMeasuredDepthTop",
            "originalMeasuredDepthBase"
         ]
      },
      "SequenceSource": {
         "title": "SequenceSource",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "sequenceExternalId": {
               "title": "Sequenceexternalid",
               "description": "An external ID of a CDF sequence.",
               "type": "string"
            },
            "sourceName": {
               "title": "Sourcename",
               "description": "Name of the source.",
               "example": "EDM",
               "type": "string"
            }
         },
         "required": [
            "sequenceExternalId",
            "sourceName"
         ]
      },
      "PhaseEnum": {
         "title": "PhaseEnum",
         "description": "An enumeration.",
         "enum": [
            "proposed",
            "planned",
            "actual"
         ],
         "type": "string"
      },
      "CasingSchematicIngestion": {
         "title": "CasingSchematicIngestion",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "wellboreAssetExternalId": {
               "title": "Wellboreassetexternalid",
               "type": "string"
            },
            "casingAssemblies": {
               "title": "Casingassemblies",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/CasingAssembly"
               }
            },
            "source": {
               "$ref": "#/definitions/SequenceSource"
            },
            "phase": {
               "$ref": "#/definitions/PhaseEnum"
            }
         },
         "required": [
            "wellboreAssetExternalId",
            "casingAssemblies",
            "source"
         ]
      }
   }
}

Config
  • allow_population_by_field_name: bool = True

Fields
field items: List[CasingSchematicIngestion] [Required]
Constraints
  • minItems = 1

  • maxItems = 1000

pydantic model cognite.well_model.models.CasingItems

Show JSON schema
{
   "title": "CasingItems",
   "description": "Well data layer base model",
   "type": "object",
   "properties": {
      "items": {
         "title": "Items",
         "type": "array",
         "items": {
            "$ref": "#/definitions/CasingSchematic"
         }
      },
      "nextCursor": {
         "title": "Nextcursor",
         "description": "The cursor to get the next page of results (if available).",
         "type": "string"
      }
   },
   "required": [
      "items"
   ],
   "definitions": {
      "DistanceUnitEnum": {
         "title": "DistanceUnitEnum",
         "description": "An enumeration.",
         "enum": [
            "meter",
            "foot",
            "inch",
            "yard"
         ],
         "type": "string"
      },
      "Distance": {
         "title": "Distance",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "value": {
               "title": "Value",
               "description": "Amount of a given unit.",
               "type": "number"
            },
            "unit": {
               "$ref": "#/definitions/DistanceUnitEnum"
            }
         },
         "required": [
            "value",
            "unit"
         ]
      },
      "WeightUnitEnum": {
         "title": "WeightUnitEnum",
         "description": "An enumeration.",
         "enum": [
            "kilogram",
            "pound"
         ],
         "type": "string"
      },
      "LinearWeightUnit": {
         "title": "LinearWeightUnit",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "weightUnit": {
               "$ref": "#/definitions/WeightUnitEnum"
            },
            "depthUnit": {
               "$ref": "#/definitions/DistanceUnitEnum"
            }
         },
         "required": [
            "weightUnit",
            "depthUnit"
         ]
      },
      "LinearWeight": {
         "title": "LinearWeight",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "value": {
               "title": "Value",
               "type": "number"
            },
            "unit": {
               "$ref": "#/definitions/LinearWeightUnit"
            }
         },
         "required": [
            "value",
            "unit"
         ]
      },
      "CasingComponent": {
         "title": "CasingComponent",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "minInsideDiameter": {
               "title": "Mininsidediameter",
               "description": "Minimum inside diameter of the casing component.",
               "allOf": [
                  {
                     "$ref": "#/definitions/Distance"
                  }
               ]
            },
            "maxOutsideDiameter": {
               "title": "Maxoutsidediameter",
               "description": "Maximum outside diameter of the casing component.",
               "allOf": [
                  {
                     "$ref": "#/definitions/Distance"
                  }
               ]
            },
            "topMeasuredDepth": {
               "title": "Topmeasureddepth",
               "description": "Top measured depth of the casing component. If both `baseMeasuredDepth` and `topMeasuredDepth` are set, then `baseMeasuredDepth` must be larger or equal to `topMeasuredDepth`.\n",
               "allOf": [
                  {
                     "$ref": "#/definitions/Distance"
                  }
               ]
            },
            "baseMeasuredDepth": {
               "title": "Basemeasureddepth",
               "description": "Base measured depth of the casing component. If both `baseMeasuredDepth` and `topMeasuredDepth` are set, then `baseMeasuredDepth` must be larger or equal to `topMeasuredDepth`.\n",
               "allOf": [
                  {
                     "$ref": "#/definitions/Distance"
                  }
               ]
            },
            "grade": {
               "title": "Grade",
               "description": "Classification of the material used in the casing component. For example L-80, or J-55.\n",
               "maxLength": 50,
               "example": "L-80",
               "type": "string"
            },
            "connectionName": {
               "title": "Connectionname",
               "description": "Name of the casing connection",
               "maxLength": 50,
               "type": "string"
            },
            "joints": {
               "title": "Joints",
               "description": "Number of component joints",
               "minimum": 1,
               "type": "integer"
            },
            "description": {
               "title": "Description",
               "description": "Casing component description",
               "maxLength": 255,
               "type": "string"
            },
            "manufacturer": {
               "title": "Manufacturer",
               "description": "Casing component manufacturer",
               "maxLength": 255,
               "type": "string"
            },
            "typeCode": {
               "title": "Typecode",
               "description": "Casing component type",
               "maxLength": 50,
               "type": "string"
            },
            "linearWeight": {
               "$ref": "#/definitions/LinearWeight"
            }
         }
      },
      "CasingAssembly": {
         "title": "CasingAssembly",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "minInsideDiameter": {
               "title": "Mininsidediameter",
               "description": "Minimum inside diameter of the casing assembly.",
               "allOf": [
                  {
                     "$ref": "#/definitions/Distance"
                  }
               ]
            },
            "minOutsideDiameter": {
               "title": "Minoutsidediameter",
               "description": "Minimum outside diameter of the casing assembly.",
               "allOf": [
                  {
                     "$ref": "#/definitions/Distance"
                  }
               ]
            },
            "maxOutsideDiameter": {
               "title": "Maxoutsidediameter",
               "description": "Maximum outside diameter of the casing assembly.",
               "allOf": [
                  {
                     "$ref": "#/definitions/Distance"
                  }
               ]
            },
            "originalMeasuredDepthTop": {
               "title": "Originalmeasureddepthtop",
               "description": "measured depth top of the casing assembly. Must be less than or equal to originalMeasuredDepthBase.",
               "allOf": [
                  {
                     "$ref": "#/definitions/Distance"
                  }
               ]
            },
            "originalMeasuredDepthBase": {
               "title": "Originalmeasureddepthbase",
               "description": "measured depth baes of the casing assembly. Must be larger than or equal to originalMeasuredDepthTop.",
               "allOf": [
                  {
                     "$ref": "#/definitions/Distance"
                  }
               ]
            },
            "type": {
               "title": "Type",
               "description": "Type of casing assembly. Examples: Intermediate casing, production casing, production liner, etc.",
               "maxLength": 255,
               "type": "string"
            },
            "reportDescription": {
               "title": "Reportdescription",
               "description": "Report description of the casing assembly",
               "type": "string"
            },
            "sectionTypeCode": {
               "title": "Sectiontypecode",
               "maxLength": 50,
               "type": "string"
            },
            "components": {
               "title": "Components",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/CasingComponent"
               }
            }
         },
         "required": [
            "minInsideDiameter",
            "minOutsideDiameter",
            "maxOutsideDiameter",
            "originalMeasuredDepthTop",
            "originalMeasuredDepthBase"
         ]
      },
      "SequenceSource": {
         "title": "SequenceSource",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "sequenceExternalId": {
               "title": "Sequenceexternalid",
               "description": "An external ID of a CDF sequence.",
               "type": "string"
            },
            "sourceName": {
               "title": "Sourcename",
               "description": "Name of the source.",
               "example": "EDM",
               "type": "string"
            }
         },
         "required": [
            "sequenceExternalId",
            "sourceName"
         ]
      },
      "PhaseEnum": {
         "title": "PhaseEnum",
         "description": "An enumeration.",
         "enum": [
            "proposed",
            "planned",
            "actual"
         ],
         "type": "string"
      },
      "CasingSchematic": {
         "title": "CasingSchematic",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "wellboreAssetExternalId": {
               "title": "Wellboreassetexternalid",
               "type": "string"
            },
            "wellboreMatchingId": {
               "title": "Wellborematchingid",
               "description": "The matching id of the wellbore related to CasingSchematic.",
               "type": "string"
            },
            "casingAssemblies": {
               "title": "Casingassemblies",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/CasingAssembly"
               }
            },
            "source": {
               "$ref": "#/definitions/SequenceSource"
            },
            "phase": {
               "$ref": "#/definitions/PhaseEnum"
            },
            "isDefinitive": {
               "title": "Isdefinitive",
               "description": "Describes if the casing schematic is definitive. A definitive casing schematic is a schematic that contains information about the actual casing assemblies for a given wellbore.",
               "type": "boolean"
            }
         },
         "required": [
            "wellboreAssetExternalId",
            "wellboreMatchingId",
            "casingAssemblies",
            "source"
         ]
      }
   }
}

Config
  • allow_population_by_field_name: bool = True

Fields
field items: List[CasingSchematic] [Required]
field next_cursor: Optional[str] = None (alias 'nextCursor')

The cursor to get the next page of results (if available).

pydantic model cognite.well_model.models.CasingSchematic

Show JSON schema
{
   "title": "CasingSchematic",
   "description": "Well data layer base model",
   "type": "object",
   "properties": {
      "wellboreAssetExternalId": {
         "title": "Wellboreassetexternalid",
         "type": "string"
      },
      "wellboreMatchingId": {
         "title": "Wellborematchingid",
         "description": "The matching id of the wellbore related to CasingSchematic.",
         "type": "string"
      },
      "casingAssemblies": {
         "title": "Casingassemblies",
         "type": "array",
         "items": {
            "$ref": "#/definitions/CasingAssembly"
         }
      },
      "source": {
         "$ref": "#/definitions/SequenceSource"
      },
      "phase": {
         "$ref": "#/definitions/PhaseEnum"
      },
      "isDefinitive": {
         "title": "Isdefinitive",
         "description": "Describes if the casing schematic is definitive. A definitive casing schematic is a schematic that contains information about the actual casing assemblies for a given wellbore.",
         "type": "boolean"
      }
   },
   "required": [
      "wellboreAssetExternalId",
      "wellboreMatchingId",
      "casingAssemblies",
      "source"
   ],
   "definitions": {
      "DistanceUnitEnum": {
         "title": "DistanceUnitEnum",
         "description": "An enumeration.",
         "enum": [
            "meter",
            "foot",
            "inch",
            "yard"
         ],
         "type": "string"
      },
      "Distance": {
         "title": "Distance",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "value": {
               "title": "Value",
               "description": "Amount of a given unit.",
               "type": "number"
            },
            "unit": {
               "$ref": "#/definitions/DistanceUnitEnum"
            }
         },
         "required": [
            "value",
            "unit"
         ]
      },
      "WeightUnitEnum": {
         "title": "WeightUnitEnum",
         "description": "An enumeration.",
         "enum": [
            "kilogram",
            "pound"
         ],
         "type": "string"
      },
      "LinearWeightUnit": {
         "title": "LinearWeightUnit",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "weightUnit": {
               "$ref": "#/definitions/WeightUnitEnum"
            },
            "depthUnit": {
               "$ref": "#/definitions/DistanceUnitEnum"
            }
         },
         "required": [
            "weightUnit",
            "depthUnit"
         ]
      },
      "LinearWeight": {
         "title": "LinearWeight",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "value": {
               "title": "Value",
               "type": "number"
            },
            "unit": {
               "$ref": "#/definitions/LinearWeightUnit"
            }
         },
         "required": [
            "value",
            "unit"
         ]
      },
      "CasingComponent": {
         "title": "CasingComponent",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "minInsideDiameter": {
               "title": "Mininsidediameter",
               "description": "Minimum inside diameter of the casing component.",
               "allOf": [
                  {
                     "$ref": "#/definitions/Distance"
                  }
               ]
            },
            "maxOutsideDiameter": {
               "title": "Maxoutsidediameter",
               "description": "Maximum outside diameter of the casing component.",
               "allOf": [
                  {
                     "$ref": "#/definitions/Distance"
                  }
               ]
            },
            "topMeasuredDepth": {
               "title": "Topmeasureddepth",
               "description": "Top measured depth of the casing component. If both `baseMeasuredDepth` and `topMeasuredDepth` are set, then `baseMeasuredDepth` must be larger or equal to `topMeasuredDepth`.\n",
               "allOf": [
                  {
                     "$ref": "#/definitions/Distance"
                  }
               ]
            },
            "baseMeasuredDepth": {
               "title": "Basemeasureddepth",
               "description": "Base measured depth of the casing component. If both `baseMeasuredDepth` and `topMeasuredDepth` are set, then `baseMeasuredDepth` must be larger or equal to `topMeasuredDepth`.\n",
               "allOf": [
                  {
                     "$ref": "#/definitions/Distance"
                  }
               ]
            },
            "grade": {
               "title": "Grade",
               "description": "Classification of the material used in the casing component. For example L-80, or J-55.\n",
               "maxLength": 50,
               "example": "L-80",
               "type": "string"
            },
            "connectionName": {
               "title": "Connectionname",
               "description": "Name of the casing connection",
               "maxLength": 50,
               "type": "string"
            },
            "joints": {
               "title": "Joints",
               "description": "Number of component joints",
               "minimum": 1,
               "type": "integer"
            },
            "description": {
               "title": "Description",
               "description": "Casing component description",
               "maxLength": 255,
               "type": "string"
            },
            "manufacturer": {
               "title": "Manufacturer",
               "description": "Casing component manufacturer",
               "maxLength": 255,
               "type": "string"
            },
            "typeCode": {
               "title": "Typecode",
               "description": "Casing component type",
               "maxLength": 50,
               "type": "string"
            },
            "linearWeight": {
               "$ref": "#/definitions/LinearWeight"
            }
         }
      },
      "CasingAssembly": {
         "title": "CasingAssembly",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "minInsideDiameter": {
               "title": "Mininsidediameter",
               "description": "Minimum inside diameter of the casing assembly.",
               "allOf": [
                  {
                     "$ref": "#/definitions/Distance"
                  }
               ]
            },
            "minOutsideDiameter": {
               "title": "Minoutsidediameter",
               "description": "Minimum outside diameter of the casing assembly.",
               "allOf": [
                  {
                     "$ref": "#/definitions/Distance"
                  }
               ]
            },
            "maxOutsideDiameter": {
               "title": "Maxoutsidediameter",
               "description": "Maximum outside diameter of the casing assembly.",
               "allOf": [
                  {
                     "$ref": "#/definitions/Distance"
                  }
               ]
            },
            "originalMeasuredDepthTop": {
               "title": "Originalmeasureddepthtop",
               "description": "measured depth top of the casing assembly. Must be less than or equal to originalMeasuredDepthBase.",
               "allOf": [
                  {
                     "$ref": "#/definitions/Distance"
                  }
               ]
            },
            "originalMeasuredDepthBase": {
               "title": "Originalmeasureddepthbase",
               "description": "measured depth baes of the casing assembly. Must be larger than or equal to originalMeasuredDepthTop.",
               "allOf": [
                  {
                     "$ref": "#/definitions/Distance"
                  }
               ]
            },
            "type": {
               "title": "Type",
               "description": "Type of casing assembly. Examples: Intermediate casing, production casing, production liner, etc.",
               "maxLength": 255,
               "type": "string"
            },
            "reportDescription": {
               "title": "Reportdescription",
               "description": "Report description of the casing assembly",
               "type": "string"
            },
            "sectionTypeCode": {
               "title": "Sectiontypecode",
               "maxLength": 50,
               "type": "string"
            },
            "components": {
               "title": "Components",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/CasingComponent"
               }
            }
         },
         "required": [
            "minInsideDiameter",
            "minOutsideDiameter",
            "maxOutsideDiameter",
            "originalMeasuredDepthTop",
            "originalMeasuredDepthBase"
         ]
      },
      "SequenceSource": {
         "title": "SequenceSource",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "sequenceExternalId": {
               "title": "Sequenceexternalid",
               "description": "An external ID of a CDF sequence.",
               "type": "string"
            },
            "sourceName": {
               "title": "Sourcename",
               "description": "Name of the source.",
               "example": "EDM",
               "type": "string"
            }
         },
         "required": [
            "sequenceExternalId",
            "sourceName"
         ]
      },
      "PhaseEnum": {
         "title": "PhaseEnum",
         "description": "An enumeration.",
         "enum": [
            "proposed",
            "planned",
            "actual"
         ],
         "type": "string"
      }
   }
}

Config
  • allow_population_by_field_name: bool = True

Fields
field casing_assemblies: List[CasingAssembly] [Required] (alias 'casingAssemblies')
field is_definitive: Optional[bool] = None (alias 'isDefinitive')

Describes if the casing schematic is definitive. A definitive casing schematic is a schematic that contains information about the actual casing assemblies for a given wellbore.

field phase: Optional[PhaseEnum] = None
field source: SequenceSource [Required]
field wellbore_asset_external_id: str [Required] (alias 'wellboreAssetExternalId')
field wellbore_matching_id: str [Required] (alias 'wellboreMatchingId')

The matching id of the wellbore related to CasingSchematic.

pydantic model cognite.well_model.models.CasingSchematicIngestion

Show JSON schema
{
   "title": "CasingSchematicIngestion",
   "description": "Well data layer base model",
   "type": "object",
   "properties": {
      "wellboreAssetExternalId": {
         "title": "Wellboreassetexternalid",
         "type": "string"
      },
      "casingAssemblies": {
         "title": "Casingassemblies",
         "type": "array",
         "items": {
            "$ref": "#/definitions/CasingAssembly"
         }
      },
      "source": {
         "$ref": "#/definitions/SequenceSource"
      },
      "phase": {
         "$ref": "#/definitions/PhaseEnum"
      }
   },
   "required": [
      "wellboreAssetExternalId",
      "casingAssemblies",
      "source"
   ],
   "definitions": {
      "DistanceUnitEnum": {
         "title": "DistanceUnitEnum",
         "description": "An enumeration.",
         "enum": [
            "meter",
            "foot",
            "inch",
            "yard"
         ],
         "type": "string"
      },
      "Distance": {
         "title": "Distance",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "value": {
               "title": "Value",
               "description": "Amount of a given unit.",
               "type": "number"
            },
            "unit": {
               "$ref": "#/definitions/DistanceUnitEnum"
            }
         },
         "required": [
            "value",
            "unit"
         ]
      },
      "WeightUnitEnum": {
         "title": "WeightUnitEnum",
         "description": "An enumeration.",
         "enum": [
            "kilogram",
            "pound"
         ],
         "type": "string"
      },
      "LinearWeightUnit": {
         "title": "LinearWeightUnit",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "weightUnit": {
               "$ref": "#/definitions/WeightUnitEnum"
            },
            "depthUnit": {
               "$ref": "#/definitions/DistanceUnitEnum"
            }
         },
         "required": [
            "weightUnit",
            "depthUnit"
         ]
      },
      "LinearWeight": {
         "title": "LinearWeight",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "value": {
               "title": "Value",
               "type": "number"
            },
            "unit": {
               "$ref": "#/definitions/LinearWeightUnit"
            }
         },
         "required": [
            "value",
            "unit"
         ]
      },
      "CasingComponent": {
         "title": "CasingComponent",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "minInsideDiameter": {
               "title": "Mininsidediameter",
               "description": "Minimum inside diameter of the casing component.",
               "allOf": [
                  {
                     "$ref": "#/definitions/Distance"
                  }
               ]
            },
            "maxOutsideDiameter": {
               "title": "Maxoutsidediameter",
               "description": "Maximum outside diameter of the casing component.",
               "allOf": [
                  {
                     "$ref": "#/definitions/Distance"
                  }
               ]
            },
            "topMeasuredDepth": {
               "title": "Topmeasureddepth",
               "description": "Top measured depth of the casing component. If both `baseMeasuredDepth` and `topMeasuredDepth` are set, then `baseMeasuredDepth` must be larger or equal to `topMeasuredDepth`.\n",
               "allOf": [
                  {
                     "$ref": "#/definitions/Distance"
                  }
               ]
            },
            "baseMeasuredDepth": {
               "title": "Basemeasureddepth",
               "description": "Base measured depth of the casing component. If both `baseMeasuredDepth` and `topMeasuredDepth` are set, then `baseMeasuredDepth` must be larger or equal to `topMeasuredDepth`.\n",
               "allOf": [
                  {
                     "$ref": "#/definitions/Distance"
                  }
               ]
            },
            "grade": {
               "title": "Grade",
               "description": "Classification of the material used in the casing component. For example L-80, or J-55.\n",
               "maxLength": 50,
               "example": "L-80",
               "type": "string"
            },
            "connectionName": {
               "title": "Connectionname",
               "description": "Name of the casing connection",
               "maxLength": 50,
               "type": "string"
            },
            "joints": {
               "title": "Joints",
               "description": "Number of component joints",
               "minimum": 1,
               "type": "integer"
            },
            "description": {
               "title": "Description",
               "description": "Casing component description",
               "maxLength": 255,
               "type": "string"
            },
            "manufacturer": {
               "title": "Manufacturer",
               "description": "Casing component manufacturer",
               "maxLength": 255,
               "type": "string"
            },
            "typeCode": {
               "title": "Typecode",
               "description": "Casing component type",
               "maxLength": 50,
               "type": "string"
            },
            "linearWeight": {
               "$ref": "#/definitions/LinearWeight"
            }
         }
      },
      "CasingAssembly": {
         "title": "CasingAssembly",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "minInsideDiameter": {
               "title": "Mininsidediameter",
               "description": "Minimum inside diameter of the casing assembly.",
               "allOf": [
                  {
                     "$ref": "#/definitions/Distance"
                  }
               ]
            },
            "minOutsideDiameter": {
               "title": "Minoutsidediameter",
               "description": "Minimum outside diameter of the casing assembly.",
               "allOf": [
                  {
                     "$ref": "#/definitions/Distance"
                  }
               ]
            },
            "maxOutsideDiameter": {
               "title": "Maxoutsidediameter",
               "description": "Maximum outside diameter of the casing assembly.",
               "allOf": [
                  {
                     "$ref": "#/definitions/Distance"
                  }
               ]
            },
            "originalMeasuredDepthTop": {
               "title": "Originalmeasureddepthtop",
               "description": "measured depth top of the casing assembly. Must be less than or equal to originalMeasuredDepthBase.",
               "allOf": [
                  {
                     "$ref": "#/definitions/Distance"
                  }
               ]
            },
            "originalMeasuredDepthBase": {
               "title": "Originalmeasureddepthbase",
               "description": "measured depth baes of the casing assembly. Must be larger than or equal to originalMeasuredDepthTop.",
               "allOf": [
                  {
                     "$ref": "#/definitions/Distance"
                  }
               ]
            },
            "type": {
               "title": "Type",
               "description": "Type of casing assembly. Examples: Intermediate casing, production casing, production liner, etc.",
               "maxLength": 255,
               "type": "string"
            },
            "reportDescription": {
               "title": "Reportdescription",
               "description": "Report description of the casing assembly",
               "type": "string"
            },
            "sectionTypeCode": {
               "title": "Sectiontypecode",
               "maxLength": 50,
               "type": "string"
            },
            "components": {
               "title": "Components",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/CasingComponent"
               }
            }
         },
         "required": [
            "minInsideDiameter",
            "minOutsideDiameter",
            "maxOutsideDiameter",
            "originalMeasuredDepthTop",
            "originalMeasuredDepthBase"
         ]
      },
      "SequenceSource": {
         "title": "SequenceSource",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "sequenceExternalId": {
               "title": "Sequenceexternalid",
               "description": "An external ID of a CDF sequence.",
               "type": "string"
            },
            "sourceName": {
               "title": "Sourcename",
               "description": "Name of the source.",
               "example": "EDM",
               "type": "string"
            }
         },
         "required": [
            "sequenceExternalId",
            "sourceName"
         ]
      },
      "PhaseEnum": {
         "title": "PhaseEnum",
         "description": "An enumeration.",
         "enum": [
            "proposed",
            "planned",
            "actual"
         ],
         "type": "string"
      }
   }
}

Config
  • allow_population_by_field_name: bool = True

Fields
field casing_assemblies: List[CasingAssembly] [Required] (alias 'casingAssemblies')
field phase: Optional[PhaseEnum] = None
field source: SequenceSource [Required]
field wellbore_asset_external_id: str [Required] (alias 'wellboreAssetExternalId')
pydantic model cognite.well_model.models.Chronostratigraphic

Show JSON schema
{
   "title": "Chronostratigraphic",
   "description": "Well data layer base model",
   "type": "object",
   "properties": {
      "age": {
         "title": "Age",
         "description": "Geochronologic age/stage. Examples: maastrichtian, danian, lutetian.",
         "example": "kasimovian",
         "type": "string"
      },
      "subEpoch": {
         "title": "Subepoch",
         "description": "Geochronologic sub epoch used in parts of north america. Example: upper pennsylvanian.",
         "example": "upper pennsylvanian",
         "type": "string"
      },
      "epoch": {
         "title": "Epoch",
         "description": "Geochronologic epoch. Examples: miocene, eocene, upper jurassic.",
         "example": "pennsylvanian",
         "type": "string"
      },
      "period": {
         "title": "Period",
         "description": "Geochronologic period. Examples. neogene, cretaceous, jurassic.",
         "example": "carboniferous",
         "type": "string"
      },
      "era": {
         "title": "Era",
         "description": "Geochronologic era: Examples: Cenozoic, Mesozoic.",
         "example": "paleozoic",
         "type": "string"
      }
   }
}

Config
  • allow_population_by_field_name: bool = True

Fields
field age: Optional[str] = None

Geochronologic age/stage. Examples: maastrichtian, danian, lutetian.

field epoch: Optional[str] = None

Geochronologic epoch. Examples: miocene, eocene, upper jurassic.

field era: Optional[str] = None

Geochronologic era: Examples: Cenozoic, Mesozoic.

field period: Optional[str] = None

Geochronologic period. Examples. neogene, cretaceous, jurassic.

field sub_epoch: Optional[str] = None (alias 'subEpoch')

Geochronologic sub epoch used in parts of north america. Example: upper pennsylvanian.

pydantic model cognite.well_model.models.ContainsAllOrAny

Show JSON schema
{
   "title": "ContainsAllOrAny",
   "description": "Well data layer base model",
   "type": "object",
   "properties": {
      "containsAll": {
         "title": "Containsall",
         "description": "match on all of the strings",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "containsAny": {
         "title": "Containsany",
         "description": "match on any of the strings",
         "type": "array",
         "items": {
            "type": "string"
         }
      }
   }
}

Config
  • allow_population_by_field_name: bool = True

Fields
field contains_all: Optional[List[str]] = None (alias 'containsAll')

match on all of the strings

field contains_any: Optional[List[str]] = None (alias 'containsAny')

match on any of the strings

pydantic model cognite.well_model.models.ContainsAllOrAnyInt

Show JSON schema
{
   "title": "ContainsAllOrAnyInt",
   "description": "Well data layer base model",
   "type": "object",
   "properties": {
      "containsAll": {
         "title": "Containsall",
         "description": "match on all of the strings",
         "type": "array",
         "items": {
            "type": "integer"
         }
      },
      "containsAny": {
         "title": "Containsany",
         "description": "match on any of the strings",
         "type": "array",
         "items": {
            "type": "integer"
         }
      }
   }
}

Config
  • allow_population_by_field_name: bool = True

Fields
field contains_all: Optional[List[int]] = None (alias 'containsAll')

match on all of the strings

field contains_any: Optional[List[int]] = None (alias 'containsAny')

match on any of the strings

pydantic model cognite.well_model.models.ContainsAllOrAnyMeasurementType

Show JSON schema
{
   "title": "ContainsAllOrAnyMeasurementType",
   "description": "Well data layer base model",
   "type": "object",
   "properties": {
      "containsAny": {
         "title": "Containsany",
         "type": "array",
         "items": {
            "type": "string"
         }
      }
   },
   "required": [
      "containsAny"
   ]
}

Config
  • allow_population_by_field_name: bool = True

Fields
field contains_any: List[str] [Required] (alias 'containsAny')
pydantic model cognite.well_model.models.CursorAndLimit

Show JSON schema
{
   "title": "CursorAndLimit",
   "description": "Well data layer base model",
   "type": "object",
   "properties": {
      "limit": {
         "title": "Limit",
         "description": "Maximum number of rows returned in one request. If there is more data beyond this limit, a cursor will be returned to enable further fetching of data.",
         "minimum": 1,
         "maximum": 1000,
         "type": "integer"
      },
      "cursor": {
         "title": "Cursor",
         "description": "Cursor for pagination returned from a previous request. Apart from cursor and limit, the rest of the request object must be the same as for the original request.",
         "type": "string"
      }
   }
}

Config
  • allow_population_by_field_name: bool = True

Fields
field cursor: Optional[str] = None

Cursor for pagination returned from a previous request. Apart from cursor and limit, the rest of the request object must be the same as for the original request.

field limit: Optional[int] = None

Maximum number of rows returned in one request. If there is more data beyond this limit, a cursor will be returned to enable further fetching of data.

Constraints
  • minimum = 1

  • maximum = 1000

pydantic model cognite.well_model.models.DateRange

Show JSON schema
{
   "title": "DateRange",
   "description": "Well data layer base model",
   "type": "object",
   "properties": {
      "min": {
         "title": "Min",
         "type": "string",
         "format": "date"
      },
      "max": {
         "title": "Max",
         "type": "string",
         "format": "date"
      }
   }
}

Config
  • allow_population_by_field_name: bool = True

Fields
field max: Optional[date] = None
field min: Optional[date] = None
pydantic model cognite.well_model.models.Datum

Show JSON schema
{
   "title": "Datum",
   "description": "Well data layer base model",
   "type": "object",
   "properties": {
      "value": {
         "title": "Value",
         "description": "Amount of a given unit.",
         "type": "number"
      },
      "unit": {
         "$ref": "#/definitions/DistanceUnitEnum"
      },
      "reference": {
         "title": "Reference",
         "description": "The name of the reference point. Eg. \"KB\" for kelly bushing.",
         "example": "KB",
         "type": "string"
      }
   },
   "required": [
      "value",
      "unit",
      "reference"
   ],
   "definitions": {
      "DistanceUnitEnum": {
         "title": "DistanceUnitEnum",
         "description": "An enumeration.",
         "enum": [
            "meter",
            "foot",
            "inch",
            "yard"
         ],
         "type": "string"
      }
   }
}

Config
  • allow_population_by_field_name: bool = True

Fields
field reference: str [Required]

The name of the reference point. Eg. “KB” for kelly bushing.

pydantic model cognite.well_model.models.DeleteEventSources

Show JSON schema
{
   "title": "DeleteEventSources",
   "description": "Well data layer base model",
   "type": "object",
   "properties": {
      "items": {
         "title": "Items",
         "minItems": 1,
         "maxItems": 1000,
         "type": "array",
         "items": {
            "$ref": "#/definitions/EventExternalId"
         }
      }
   },
   "required": [
      "items"
   ],
   "definitions": {
      "EventExternalId": {
         "title": "EventExternalId",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "eventExternalId": {
               "title": "Eventexternalid",
               "type": "string"
            }
         },
         "required": [
            "eventExternalId"
         ]
      }
   }
}

Config
  • allow_population_by_field_name: bool = True

Fields
field items: List[EventExternalId] [Required]
Constraints
  • minItems = 1

  • maxItems = 1000

pydantic model cognite.well_model.models.DeleteExternalIdSource

Show JSON schema
{
   "title": "DeleteExternalIdSource",
   "description": "Well data layer base model",
   "type": "object",
   "properties": {
      "items": {
         "title": "Items",
         "description": "List of externalIds to delete.",
         "minItems": 1,
         "maxItems": 1000,
         "type": "array",
         "items": {
            "$ref": "#/definitions/ExternalIdSource"
         }
      }
   },
   "required": [
      "items"
   ],
   "definitions": {
      "ExternalIdSource": {
         "title": "ExternalIdSource",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "externalId": {
               "title": "Externalid",
               "description": "An external id of a resource.",
               "type": "string"
            }
         },
         "required": [
            "externalId"
         ]
      }
   }
}

Config
  • allow_population_by_field_name: bool = True

Fields
field items: List[ExternalIdSource] [Required]

List of externalIds to delete.

Constraints
  • minItems = 1

  • maxItems = 1000

pydantic model cognite.well_model.models.DeleteSequenceSources

Show JSON schema
{
   "title": "DeleteSequenceSources",
   "description": "Well data layer base model",
   "type": "object",
   "properties": {
      "items": {
         "title": "Items",
         "minItems": 1,
         "maxItems": 1000,
         "type": "array",
         "items": {
            "$ref": "#/definitions/SequenceExternalId"
         }
      }
   },
   "required": [
      "items"
   ],
   "definitions": {
      "SequenceExternalId": {
         "title": "SequenceExternalId",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "sequenceExternalId": {
               "title": "Sequenceexternalid",
               "description": "An external id for a sequence in CDF.",
               "type": "string"
            }
         },
         "required": [
            "sequenceExternalId"
         ]
      }
   }
}

Config
  • allow_population_by_field_name: bool = True

Fields
field items: List[SequenceExternalId] [Required]
Constraints
  • minItems = 1

  • maxItems = 1000

pydantic model cognite.well_model.models.DeleteSources

Show JSON schema
{
   "title": "DeleteSources",
   "description": "Well data layer base model",
   "type": "object",
   "properties": {
      "items": {
         "title": "Items",
         "minItems": 1,
         "maxItems": 1000,
         "type": "array",
         "items": {
            "$ref": "#/definitions/Source"
         }
      }
   },
   "required": [
      "items"
   ],
   "definitions": {
      "Source": {
         "title": "Source",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "example": "EDM",
               "type": "string"
            },
            "description": {
               "title": "Description",
               "type": "string"
            }
         },
         "required": [
            "name"
         ]
      }
   }
}

Config
  • allow_population_by_field_name: bool = True

Fields
field items: List[Source] [Required]
Constraints
  • minItems = 1

  • maxItems = 1000

pydantic model cognite.well_model.models.DeleteWells

Show JSON schema
{
   "title": "DeleteWells",
   "description": "Well data layer base model",
   "type": "object",
   "properties": {
      "items": {
         "title": "Items",
         "minItems": 1,
         "maxItems": 1000,
         "type": "array",
         "items": {
            "$ref": "#/definitions/AssetSource"
         }
      },
      "recursive": {
         "title": "Recursive",
         "description": "If set to true, it will delete associated wellbores, measurements, NPT/NDS etc.\nIf set to false, it will fail if one of the wells have associated wellbores.",
         "default": false,
         "type": "boolean"
      }
   },
   "required": [
      "items"
   ],
   "definitions": {
      "AssetSource": {
         "title": "AssetSource",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "assetExternalId": {
               "title": "Assetexternalid",
               "description": "Asset external ID.",
               "type": "string"
            },
            "sourceName": {
               "title": "Sourcename",
               "description": "Name of the source this asset external ID belongs to.",
               "example": "EDM",
               "type": "string"
            }
         },
         "required": [
            "assetExternalId",
            "sourceName"
         ]
      }
   }
}

Config
  • allow_population_by_field_name: bool = True

Fields
field items: List[AssetSource] [Required]
Constraints
  • minItems = 1

  • maxItems = 1000

field recursive: Optional[bool] = False

If set to true, it will delete associated wellbores, measurements, NPT/NDS etc. If set to false, it will fail if one of the wells have associated wellbores.

pydantic model cognite.well_model.models.DepthIndexColumn

Show JSON schema
{
   "title": "DepthIndexColumn",
   "description": "Well data layer base model",
   "type": "object",
   "properties": {
      "columnExternalId": {
         "title": "Columnexternalid",
         "description": "External id of the sequence column",
         "example": "MD",
         "type": "string"
      },
      "unit": {
         "$ref": "#/definitions/DistanceUnit"
      },
      "type": {
         "$ref": "#/definitions/DepthIndexTypeEnum"
      }
   },
   "required": [
      "columnExternalId",
      "unit",
      "type"
   ],
   "definitions": {
      "DistanceUnitEnum": {
         "title": "DistanceUnitEnum",
         "description": "An enumeration.",
         "enum": [
            "meter",
            "foot",
            "inch",
            "yard"
         ],
         "type": "string"
      },
      "DistanceUnit": {
         "title": "DistanceUnit",
         "description": "Well data layer base model",
         "type": "object",
         "properties": {
            "unit": {
               "$ref": "#/definitions/DistanceUnitEnum"
            },
            "factor": {
               "title": "Factor",
               "default": 1.0,
               "example": 1.0,
               "type": "number"
            }
         },
         "required": [
            "unit"
         ]
      },
      "DepthIndexTypeEnum": {
         "title": "DepthIndexTypeEnum",
         "description": "An enumeration.",
         "enum": [
            "measured depth",
            "true vertical depth"
         ],
         "type": "string"
      }
   }
}

Config
  • allow_population_by_field_name: bool = True

Fields
field column_external_id: str [Required] (alias 'columnExternalId')

External id of the sequence column

field type: DepthIndexTypeEnum [Required]
field unit: DistanceUnit [Required]
class cognite.well_model.models.DepthIndexTypeEnum(value)

An enumeration.

pydantic model cognite.well_model.models.DepthMeasurement

Show JSON schema
{
   "title": "DepthMeasurement",
   "description": "Well data layer base model",
   "type": "object",
   "properties": {
      "wellboreAssetExternalId": {
         "title": "Wellboreassetexternalid",
         "description": "The CDF asset external id of the wellbore. The asset must have been ingested as a wellbore with the same source as this NPT event.",
         "type": "string"
      },
      "wellboreMatchingId": {
         "title": "Wellborematchingid",
         "description": "The matching id of the wellbore related to depth measurement.",
         "type": "string"
      },
      "source": {
         "$ref": "#/definitions/SequenceSource"
      },
      "depthColumn": {
         "$ref": "#/definitions/DepthIndexColumn"
      },
      "datum": {
         "$ref": "#/definitions/Datum"
      },
      "columns": {
         "title": "Columns",
         "type": "array",
         "items": {
            "$ref": "#/definitions/DepthMeasurementColumn"
         }
      },
      "run": {
         "title": "Run",
         "type": "string"
      },
      "producer": {
         "title": "Producer",
         "type": "string"
      },
      "startTime": {
         "title": "Starttime",
         "description": "The time the depth measurement started. The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.",
         "type": "integer"
      },