{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Wellbore DDMS Geology APIs","description":"Accelerate E&P application development and protect your innovation by consuming our Data and Domain APIs / Platform APIs.","lang":"en-US","meta":[{"name":"robots","content":"noindex"}],"llmstxt":{"hide":true,"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"wellbore-ddms-geology-apis","__idx":0},"children":["Wellbore DDMS Geology APIs"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#introduction"},"children":["Introduction"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#schemas"},"children":["Schemas"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#apis"},"children":["APIs"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#sample-data"},"children":["Sample data"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#simple-create-read-session"},"children":["Simple Create / Read session"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"introduction","__idx":1},"children":["Introduction",{"$$mdtype":"Tag","name":"a","attributes":{"name":"introduction"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Wellbore DDMS Geology APIs let the user manage Markers related to a Wellbore, with CRUD APIs for MarkerSets."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"schemas","__idx":2},"children":["Schemas",{"$$mdtype":"Tag","name":"a","attributes":{"name":"schemas"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Wellbore DDMS Geology APIs support the OSDU ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://community.opengroup.org/osdu/data/data-definitions/-/blob/v0.15.0/E-R/work-product-component/WellboreMarkerSet.1.1.0.md"},"children":["WellboreMarkerSet schema"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"apis","__idx":3},"children":["APIs",{"$$mdtype":"Tag","name":"a","attributes":{"name":"apis"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3-markers"},"children":["Wellbore DDMS Geology APIs specification"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Those are generic Create Read Update Delete (CRUD) APIs to manage WellboreMarkerSet objects."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"sample-data","__idx":4},"children":["Sample data",{"$$mdtype":"Tag","name":"a","attributes":{"name":"sample-data"},"children":[]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["\n        Among the WellboreMarkerSet data fields are the WellboreID to which it is related, and a Markers array.\n    "]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"  \"data\": {\n    \"Name\": \"string\",\n    \"Description\": \"string\",\n    \"CreationDateTime\": \"2021-12-02T15:19:19.271000+00:00\",\n    \"Tags\": [\n      \"string\"\n    ],\n    \"SpatialPoint\": {},\n    \"SpatialArea\": {},\n    \"GeoContexts\": [\n      \"string\"\n    ],\n    \"SubmitterName\": \"string\",\n    \"BusinessActivities\": [\n      \"string\"\n    ],\n    \"AuthorIDs\": [\n      \"string\"\n    ],\n    \"LineageAssertions\": [\n      {\n        \"ID\": \"mydata:osdu:string:00001234\",\n        \"LineageRelationshipType\": \"mydata:reference-data--LineageRelationshipType:string:\"\n      }\n    ],\n    \"Artefacts\": [\n      {\n        \"RoleID\": \"mydata:reference-data--ArtefactRole:string:\",\n        \"ResourceKind\": \"mydata:osdu:string:00001234\",\n        \"ResourceID\": \"mydata:dataset--string:string:\"\n      }\n    ],\n    \"IsExtendedLoad\": true,\n    \"IsDiscoverable\": true,\n    \"ResourceHomeRegionID\": \"mydata:reference-data--OSDURegion:string:\",\n    \"ResourceHostRegionIDs\": [\n      \"mydata:reference-data--OSDURegion:string:\"\n    ],\n    \"ResourceCurationStatus\": \"mydata:reference-data--ResourceCurationStatus:string:\",\n    \"ResourceLifecycleStatus\": \"mydata:reference-data--ResourceLifecycleStatus:string:\",\n    \"ResourceSecurityClassification\": \"mydata:reference-data--ResourceSecurityClassification:string:\",\n    \"Source\": \"string\",\n    \"ExistenceKind\": \"mydata:reference-data--ExistenceKind:string:\",\n    \"WellboreID\": \"mydata:master-data--Wellbore:00001234:\",\n    \"VerticalMeasurement\": {},\n    \"AvailableMarkerProperties\": [\n      {\n        \"MarkerPropertyTypeID\": \"mydata:reference-data--MarkerPropertyType:MissingThickness:\",\n        \"MarkerPropertyUnitID\": \"mydata:reference-data--UnitOfMeasure:ft:\",\n        \"Name\": \"MissingThickness\"\n      }\n    ],\n    \"Markers\": [\n      {\n        \"MarkerName\": \"string\",\n        \"MarkerMeasuredDepth\": 0.0,\n        \"MarkerSubSeaVerticalDepth\": 0.0,\n        \"MarkerDate\": \"2021-12-02T15:19:19.271000+00:00\",\n        \"MarkerObservationNumber\": 0.0,\n        \"MarkerInterpreter\": \"string\",\n        \"MarkerTypeID\": \"mydata:reference-data--MarkerType:string:\",\n        \"FeatureTypeID\": \"mydata:reference-data--FeatureType:string:\",\n        \"FeatureName\": \"string\",\n        \"PositiveVerticalDelta\": 0.0,\n        \"NegativeVerticalDelta\": 0.0,\n        \"SurfaceDipAngle\": 0.0,\n        \"SurfaceDipAzimuth\": 0.0,\n        \"Missing\": \"string\",\n        \"GeologicalAge\": \"string\"\n      }\n    ],\n    \"ExtensionProperties\": {}\n  }\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"simple-create--read-session","__idx":5},"children":["Simple Create / Read session",{"$$mdtype":"Tag","name":"a","attributes":{"name":"simple-create-read-session"},"children":[]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"python","header":{"controls":{"copy":{}}},"source":"import requests\nimport json\n","lang":"python"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"python","header":{"controls":{"copy":{}}},"source":"base_url=\"https://www.example.com/api/os-wellbore-ddms\"\ntoken = '****'\ndatapartitionid = 'mydata'\ndomain = 'example.com'\n","lang":"python"},"children":[]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["\n        Creating a WellboreMarkerSet record\n    "]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"python","header":{"controls":{"copy":{}}},"source":"url = f\"{base_url}/ddms/v3/wellboremarkersets\"\n\npayload = json.dumps([\n  {\n    \"acl\": {\n      \"owners\": [\n        f\"data.default.owners@{datapartitionid}.{domain}\"\n      ],\n      \"viewers\": [\n        f\"data.default.viewers@{datapartitionid}.{domain}\"\n      ]\n    },\n    \"ancestry\": {\n      \"parents\": []\n    },\n    \"createTime\": \"2020-12-16T11:46:20.163Z\",\n    \"createUser\": \"some-user@some-company-cloud.com\",\n    \"data\": {\n      \"Artefacts\": [\n        {\n          \"ResourceID\": f\"{datapartitionid}:dataset--string:string:\",\n          \"ResourceKind\": f\"{datapartitionid}:osdu:string:00001234\",\n          \"RoleID\": f\"{datapartitionid}:reference-data--ArtefactRole:string:\"\n        }\n      ],\n      \"AuthorIDs\": [\n        \"string\"\n      ],\n      \"AvailableMarkerProperties\": [\n        {\n          \"MarkerPropertyTypeID\": f\"{datapartitionid}:reference-data--MarkerPropertyType:MissingThickness:\",\n          \"MarkerPropertyUnitID\": f\"{datapartitionid}:reference-data--UnitOfMeasure:ft:\",\n          \"Name\": \"MissingThickness\"\n        }\n      ],\n      \"BusinessActivities\": [\n        \"string\"\n      ],\n      \"CreationDateTime\": \"2021-12-02T15:19:19.271Z\",\n      \"Description\": \"string\",\n      \"ExistenceKind\": f\"{datapartitionid}:reference-data--ExistenceKind:string:\",\n      \"ExtensionProperties\": {},\n      \"GeoContexts\": [\n        \"string\"\n      ],\n      \"IsDiscoverable\": True,\n      \"IsExtendedLoad\": True,\n      \"LineageAssertions\": [\n        {\n          \"ID\": f\"{datapartitionid}:osdu:string:00001234\",\n          \"LineageRelationshipType\": f\"{datapartitionid}:reference-data--LineageRelationshipType:string:\"\n        }\n      ],\n      \"Markers\": [\n        {\n          \"FeatureName\": \"string\",\n          \"FeatureTypeID\": f\"{datapartitionid}:reference-data--FeatureType:string:\",\n          \"GeologicalAge\": \"string\",\n          \"MarkerDate\": \"2021-12-02T15:19:19.271Z\",\n          \"MarkerInterpreter\": \"string\",\n          \"MarkerMeasuredDepth\": 0,\n          \"MarkerName\": \"string\",\n          \"MarkerObservationNumber\": 0,\n          \"MarkerSubSeaVerticalDepth\": 0,\n          \"MarkerTypeID\": f\"{datapartitionid}:reference-data--MarkerType:string:\",\n          \"Missing\": \"string\",\n          \"NegativeVerticalDelta\": 0,\n          \"PositiveVerticalDelta\": 0,\n          \"SurfaceDipAngle\": 0,\n          \"SurfaceDipAzimuth\": 0\n        }\n      ],\n      \"Name\": \"string\",\n      \"ResourceCurationStatus\": f\"{datapartitionid}:reference-data--ResourceCurationStatus:string:\",\n      \"ResourceHomeRegionID\": f\"{datapartitionid}:reference-data--OSDURegion:string:\",\n      \"ResourceHostRegionIDs\": [\n        f\"{datapartitionid}:reference-data--OSDURegion:string:\"\n      ],\n      \"ResourceLifecycleStatus\": f\"{datapartitionid}:reference-data--ResourceLifecycleStatus:string:\",\n      \"ResourceSecurityClassification\": f\"{datapartitionid}:reference-data--ResourceSecurityClassification:string:\",\n      \"Source\": \"string\",\n      \"SpatialArea\": {},\n      \"SpatialPoint\": {},\n      \"SubmitterName\": \"string\",\n      \"Tags\": [\n        \"string\"\n      ],\n      \"VerticalMeasurement\": {},\n      \"WellboreID\": f\"{datapartitionid}:master-data--Wellbore:00001234:\"\n    },\n    \"id\": f\"{datapartitionid}:work-product-component--WellboreMarkerSet:00001234\",\n    \"kind\": \"osdu:wks:work-product-component--WellboreMarkerSet:1.1.0\",\n    \"legal\": {\n      \"legaltags\": [\n        f\"{datapartitionid}-default-legal\"\n      ],\n      \"otherRelevantDataCountries\": [\n        \"FR\",\n        \"US\"\n      ]\n    },\n    \"meta\": [],\n    \"modifyTime\": \"2020-12-16T11:52:24.477Z\",\n    \"modifyUser\": \"some-user@some-company-cloud.com\",\n    \"tags\": {\n      \"NameOfKey\": \"String value\"\n    },\n    \"version\": 1562066009929332\n  }\n])\nheaders = {\n  'data-partition-id': f'{datapartitionid}',\n  'Content-Type': 'application/json',\n  'Authorization': f'Bearer {token}'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\n","lang":"python"},"children":[]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["Query results"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"python","header":{"controls":{"copy":{}}},"source":"print(json.dumps(response.json(), indent=2))\n\n","lang":"python"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["{"," ","\"recordCount\": 1,"," ","\"recordIdVersions\": ["," ","\"mydata:work-product-component--WellboreMarkerSet:00001234:1656929137041793\""," ","],"," ","\"recordIds\": ["," ","\"mydata:work-product-component--WellboreMarkerSet:00001234\""," ","],"," ","\"skippedRecordIds\": []"," ","}"]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["\n        Retrieving a WellboreMarkerSet record\n    "]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"python","header":{"controls":{"copy":{}}},"source":"url = f\"{base_url}/ddms/v3/wellboremarkersets/{datapartitionid}:work-product-component--WellboreMarkerSet:00001234\"\n\npayload={}\nheaders = {\n  'data-partition-id': f'{datapartitionid}',\n  'Authorization': f'Bearer {token}'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\n","lang":"python"},"children":[]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["Query results"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"python","header":{"controls":{"copy":{}}},"source":"print(json.dumps(response.json(), indent=2))\n","lang":"python"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"\n    {\n      \"id\": \"mydata:work-product-component--WellboreMarkerSet:00001234\",\n      \"kind\": \"osdu:wks:work-product-component--WellboreMarkerSet:1.1.0\",\n      \"version\": 1656929137041793,\n      \"acl\": {\n        \"owners\": [\n          \"data.default.owners@mydata.example.com\"\n        ],\n        \"viewers\": [\n          \"data.default.viewers@mydata.example.com\"\n        ]\n      },\n      \"legal\": {\n        \"legaltags\": [\n          \"mydata-default-legal\"\n        ],\n        \"otherRelevantDataCountries\": [\n          \"FR\",\n          \"US\"\n        ]\n      },\n      \"tags\": {\n        \"NameOfKey\": \"String value\"\n      },\n      \"createTime\": \"2021-12-16T15:20:59.752000+00:00\",\n      \"createUser\": \"some-user@some-company-cloud.com\",\n      \"modifyTime\": \"2022-07-04T10:05:37.050000+00:00\",\n      \"modifyUser\": \"some-user@some-company-cloud.com\",\n      \"meta\": [],\n      \"data\": {\n        \"Name\": \"string\",\n        \"Description\": \"string\",\n        \"CreationDateTime\": \"2021-12-02T15:19:19.271000+00:00\",\n        \"Tags\": [\n          \"string\"\n        ],\n        \"SpatialPoint\": {},\n        \"SpatialArea\": {},\n        \"GeoContexts\": [\n          \"string\"\n        ],\n        \"SubmitterName\": \"string\",\n        \"BusinessActivities\": [\n          \"string\"\n        ],\n        \"AuthorIDs\": [\n          \"string\"\n        ],\n        \"LineageAssertions\": [\n          {\n            \"ID\": \"mydata:osdu:string:00001234\",\n            \"LineageRelationshipType\": \"mydata:reference-data--LineageRelationshipType:string:\"\n          }\n        ],\n        \"Artefacts\": [\n          {\n            \"RoleID\": \"mydata:reference-data--ArtefactRole:string:\",\n            \"ResourceKind\": \"mydata:osdu:string:00001234\",\n            \"ResourceID\": \"mydata:dataset--string:string:\"\n          }\n        ],\n        \"IsExtendedLoad\": true,\n        \"IsDiscoverable\": true,\n        \"ResourceHomeRegionID\": \"mydata:reference-data--OSDURegion:string:\",\n        \"ResourceHostRegionIDs\": [\n          \"mydata:reference-data--OSDURegion:string:\"\n        ],\n        \"ResourceCurationStatus\": \"mydata:reference-data--ResourceCurationStatus:string:\",\n        \"ResourceLifecycleStatus\": \"mydata:reference-data--ResourceLifecycleStatus:string:\",\n        \"ResourceSecurityClassification\": \"mydata:reference-data--ResourceSecurityClassification:string:\",\n        \"Source\": \"string\",\n        \"ExistenceKind\": \"mydata:reference-data--ExistenceKind:string:\",\n        \"WellboreID\": \"mydata:master-data--Wellbore:00001234:\",\n        \"VerticalMeasurement\": {},\n        \"AvailableMarkerProperties\": [\n          {\n            \"MarkerPropertyTypeID\": \"mydata:reference-data--MarkerPropertyType:MissingThickness:\",\n            \"MarkerPropertyUnitID\": \"mydata:reference-data--UnitOfMeasure:ft:\",\n            \"Name\": \"MissingThickness\"\n          }\n        ],\n        \"Markers\": [\n          {\n            \"MarkerName\": \"string\",\n            \"MarkerMeasuredDepth\": 0.0,\n            \"MarkerSubSeaVerticalDepth\": 0.0,\n            \"MarkerDate\": \"2021-12-02T15:19:19.271000+00:00\",\n            \"MarkerObservationNumber\": 0.0,\n            \"MarkerInterpreter\": \"string\",\n            \"MarkerTypeID\": \"mydata:reference-data--MarkerType:string:\",\n            \"FeatureTypeID\": \"mydata:reference-data--FeatureType:string:\",\n            \"FeatureName\": \"string\",\n            \"PositiveVerticalDelta\": 0.0,\n            \"NegativeVerticalDelta\": 0.0,\n            \"SurfaceDipAngle\": 0.0,\n            \"SurfaceDipAzimuth\": 0.0,\n            \"Missing\": \"string\",\n            \"GeologicalAge\": \"string\"\n          }\n        ],\n        \"ExtensionProperties\": {}\n      }\n    }\n","lang":"json"},"children":[]}]}]},"headings":[{"value":"Wellbore DDMS Geology APIs","id":"wellbore-ddms-geology-apis","depth":1},{"value":"Introduction","id":"introduction","depth":2},{"value":"Schemas","id":"schemas","depth":2},{"value":"APIs","id":"apis","depth":2},{"value":"Sample data","id":"sample-data","depth":3},{"value":"Simple Create / Read session","id":"simple-create--read-session","depth":3}],"frontmatter":{"seo":{"title":"Wellbore DDMS Geology APIs"}},"lastModified":"2026-04-20T20:41:52.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/solutions/wellbore-dms/tutorial/geology","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}