Introduction
IBM Open Data for Industries provides a toolset that supports an industry-standard methodology for collecting and describing Oil & Gas data and serving that data to various applications and services that consume it.
The Open Data for Industries API enables you to enrich, index, search, and manage your data.
The following IBM Open Data for Industries methods can be leveraged to build data agnostic applications:
- Entitlements methods
- Entitlements methods enable authorization.
- File methods
- File methods provide a mechanism to fetch records and file locations.
- Indexer methods
- Indexer methods provide a mechanism to re-index records for efficient search.
- Legal methods
- Legal methods govern the data compliance through the Records in the storage API.
- Schema methods
- Schema methods provide a mechanism for publishing and managing data structure definitions.
- Search methods
- Search methods provide a mechanism for indexing documents that contain structured data.
- Storage methods
- Storage methods provide a set of APIs to manage the entire metadata lifecycle.
- Workflow methods
- Workflow methods provide a mechanism to manage process executions.
Wellbore methods Manage Well data lifecycle to support Well domain management.
- Seismic methods
- Manage Seismic data lifecycle to support Seismic domain management.
- Well Delivery methods
- Support upstream well drilling operations by combining the Well Planning and Well Execution processes.
JWT authentication
You can configure Open Data for Industries to accept JSON Web Tokens (JWT) as an authentication mechanism for the service.
A JWT is a set of JSON claims that are signed, encrypted, or both, and are encoded into a web safe form.
The Open Data for Industries REST API uses the authorization: Bearer ${JWT_ACCESS_TOKEN} as a header parameter for authentication. This parameter is provided automatically by the service proxy. You must not specify any value.
JWT access token
You can fetch the JWT access token (JWT_ACCESS_TOKEN) by running the following curl command:
curl --silent --insecure --request POST --url {$tokenEndPointBase}/auth/realms/OSDU/protocol/openid-connect/token --header 'content-type: application/x-www-form-urlencoded' --data grant_type=password --data client_id={$clientID} --data client_secret={$clientSecret} --data username={$uName} --data password={$pass} --data scope=openid | jq -r '.access_token'
Replace the following values:
| Name | Replace with |
|---|---|
{tokenEndPointBase} |
Keycloak route from the Red Hat OpenShift cluster. |
{clientID} |
The default value is osdu-login |
{clientSecret} |
Value that you can find on the OpenShift cluster secrets Admin page. Otherwise, ask your cluster administrator. |
{uName} |
Value that you can find on the OpenShift cluster secrets Admin page. Otherwise, ask your cluster administrator. |
{pass} |
Value that you can find on the OpenShift cluster secrets Admin page. Otherwise, ask your cluster administrator. |
Endpoint URL
The Open Data for Industries API endpoint URL is based on your IBM Cloud Pak deployment URL.
https://{cpd_cluster_host}{:port}/{proxy-prefix}/api/{method-name}/{version}/
Additionally, replace the following values based on the method that you want to use:
| Name | Valid values |
|---|---|
{proxy-prefix} |
osdu-delivery, osdu-entitlements-v2, osdu-legal, osdu-storage, osdu-schema, osdu-search, osdu-file, osdu-indexer, osdu-workflow, osdu-wellbore, osdu-seismic, osdu-well-delivery |
{method-name} |
delivery, entitlements, legal, storage, schema, search, file, indexer, worflow, os-wellbore-ddms |
{version} |
v1 or v2 or v3 |
When you call the API, add the path for each method to form the complete API endpoint for your request. For example, if your instance is deployed at https://www.example.com:31843, you can access the APIs at https://www.example.com:31843/{proxy-prefix}/api/{method-name}/{version}/.
Example
curl -H "cache-control: no-cache" -X {request_method} "https://{cpd_cluster_host}{:port}/{proxy-prefix}/api/{method-name}/{version}/"
Error handling
Open Data for Industries uses standard HTTP response codes to indicate whether a method completed successfully. HTTP response codes in the 2xx range indicate success. A response in the 4xx range is some sort of failure, and a response in the 5xx range usually indicates an internal system error that cannot be resolved by the user. Response codes are listed with the method.
| Name | Description |
|---|---|
| code{: .parameter-name .required} string |
An identifier of the response. |
| message{: .parameter-name .required} string |
An explanation of the problem. |
Methods
Request
Custom Headers
Tenant identifier
Allowable values: [
*/*,application/json]
Path Parameters
AddMemberDto
Allowable values: [
MEMBER,OWNER]
curl -k -X POST -H "data-partition-id: {partition_id}" -d '{ "email": "string" }' "https://{cpd_cluster_host}{:port}/osdu-entitlements/api/entitlements/v2/groups/{group_email}/members"
Request
Custom Headers
Tenant identifier
Frame for unit measurement
Request to get signed URL
State registration number for resources
curl -k -X POST -H "data-partition-id: {partition_id}" -d "{\"srns\":\"string\"}" "https://{cpd_cluster_host}{:port}/osdu-file/api/file/v2/delivery/GetFileSignedUrl"
Response
- processed
Unprocessed response
Status Code
OK
Created
Unauthorized
Forbidden
Not Found
{ "processed": { "additionalProp1": { "connectionString": "srn:file/segy:mysegy1", "kind": "common:welldb:wellbore:1.0.0", "signedUrl": "signed-url", "unsignedUrl": "unsigned-url" } }, "unprocessed": [ "[srn:file/segy:mysegy2,srn:file/segy:mysegy3]" ] }
Request
Custom Headers
Tenant identifier
Frame for unit measurement
Metadata of file
- meta
- any property
- tags
curl -k -X POST https://{HOSTNAME}:{PORT_NUMBER}/osdu-file/api/file/v2/files/metadata -H 'content-type: application/json' -H "data-partition-id: {partition_id}" -d '{ "data": { "Endian": "BIG", "Description": "As originally delivered by ACME.com.", "DatasetProperties": { "FileSourceInfo": { "FileSource": "", "Name": "1234", "PreLoadFilePath": "gs://osdu-cicd-epam-persistent-area/c3af38c1-654d-47a0-a3e6-9e94c32add84/b62b104f843142f49ee6d747e6bdd49d", "PreloadFileCreateUser": "user1", "PreloadFileModifyDate": "mar 11", "PreloadFileModifyUser": "mar 11" } }, "TotalSize": "13245217273", "Source": "Example Data Source", "Name": "Dataset X221/15" }, "kind": "osdu:wks:dataset--File.Generic:1.0.0", "acl": { "viewers": [ "data.default.viewers@opendes.osdu-gcp.go3-nrg.projects.epam.com" ], "owners": [ "data.default.owners@opendes.osdu-gcp.go3-nrg.projects.epam.com" ] }, "legal": { "legaltags": [ "opendes-demo-legaltag" ], "otherRelevantDataCountries": [ "US" ], "status": "compliant" }, "createUser": "osdu-community-sa-airflow@nice-etching-277309.iam.gserviceaccount.com", "createTime": "2021-02-22T18:50:47.498Z", "modifyUser": "osdu-community-sa-airflow@nice-etching-277309.iam.gserviceaccount.com", "modifyTime": "2021-02-22T21:13:10.587Z" }'
Request
Custom Headers
Tenant identifier
Default:
commonAuthentication key for API access
Default:
this_123_is_456_dev_789_keyAllowable values: [
*/*,application/json]
Query Parameters
Flag to control indexing of partial or full records for particular kind.[ True : All records reindexed , False : Only delta records indexed]
Default:
false
recordReindexRequest
curl -k -X POST https://{HOSTNAME}:{PORT_NUMBER}/osdu-workflow/api/indexer/v2/reindex?force_clean=true -H 'content-type: application/json' -H "data-partition-id: {partition_id}" -d '{ "kind": "opendes:osdu:well-master:0.2.1" }'
Request
Custom Headers
Tenant identifier
Allowable values: [
*/*,application/json]
legalTag
The contract identity
The legal tag description
The expiration date
Legal tag name
curl -k -X PUT -H "data-partition-id: {partition_id}" -d '{ "contractId": "string", "description": "string", "expirationDate": "2020-10-13", "name": "string" }' "https://{cpd_cluster_host}{:port}/osdu-legal/api/legal/v1/legaltags"
Response
Legal tag description
Legal tag name
Status Code
OK
Created
Unauthorized Access
Forbidden Access
Endpoint Not Found
{ "contractId": "AE12345", "description": "Legal tag description", "expirationDate": "2022-12-22", "name": "common-demo-legaltag" }{ "_messageCode_": "201", "message": "Created" }
Request
Custom Headers
Tenant identifier
Allowable values: [
*/*,application/json]
legalTag
Legal tag description
Legal tag name
curl -k -X POST -H "data-partition-id: {partition_id}" -d '{ "description": "string", "name": "string", "properties": { "contractId": "string", "countryOfOrigin": [ "string" ], "dataType": "string", "expirationDate": "yyyy-MM-dd", "exportClassification": "string", "originator": "string", "personalData": "string", "securityClassification": "string" } }' "https://{cpd_cluster_host}{:port}/osdu-legal/api/legal/v1/legaltags"
Response
Legal tag description
Legal tag name
Status Code
OK
Created
Unauthorized Access
Forbidden Access
Endpoint Not Found
{ "description": "This is the description of legal tag", "name": "legal-tag-name", "properties": { "contractId": "legal-contract-id", "countryOfOrigin": [ "[USA,CANADA,UK]" ], "dataType": "Public Domain Data", "expirationDate": "yyyy-MM-dd", "exportClassification": "EAR99", "originator": "ODI", "personalData": "Personal Data", "securityClassification": "Public" } }{ "_messageCode_": "201", "message": "Created" }
Request
Custom Headers
Tenant identifier
Path Parameters
Legal tag name
curl -k -X GET -H "data-partition-id: {partition_id}" "https://{cpd_cluster_host}{:port}/osdu-legal/api/legal/v1/legaltags/{name}"
Response
- body
Legal tag name
The contract identity
The expiration date
The response status code
Possible values: [
100 CONTINUE,101 SWITCHING_PROTOCOLS,102 PROCESSING,103 CHECKPOINT,200 OK,201 CREATED,202 ACCEPTED,203 NON_AUTHORITATIVE_INFORMATION,204 NO_CONTENT,205 RESET_CONTENT,206 PARTIAL_CONTENT,207 MULTI_STATUS,208 ALREADY_REPORTED,226 IM_USED,300 MULTIPLE_CHOICES,301 MOVED_PERMANENTLY,302 FOUND,302 MOVED_TEMPORARILY,303 SEE_OTHER,304 NOT_MODIFIED,305 USE_PROXY,307 TEMPORARY_REDIRECT,308 PERMANENT_REDIRECT,400 BAD_REQUEST,401 UNAUTHORIZED,402 PAYMENT_REQUIRED,403 FORBIDDEN,404 NOT_FOUND,405 METHOD_NOT_ALLOWED,406 NOT_ACCEPTABLE,407 PROXY_AUTHENTICATION_REQUIRED,408 REQUEST_TIMEOUT,409 CONFLICT,410 GONE,411 LENGTH_REQUIRED,412 PRECONDITION_FAILED,413 PAYLOAD_TOO_LARGE,413 REQUEST_ENTITY_TOO_LARGE,414 URI_TOO_LONG,414 REQUEST_URI_TOO_LONG,415 UNSUPPORTED_MEDIA_TYPE,416 REQUESTED_RANGE_NOT_SATISFIABLE,417 EXPECTATION_FAILED,418 I_AM_A_TEAPOT,419 INSUFFICIENT_SPACE_ON_RESOURCE,420 METHOD_FAILURE,421 DESTINATION_LOCKED,422 UNPROCESSABLE_ENTITY,423 LOCKED,424 FAILED_DEPENDENCY,426 UPGRADE_REQUIRED,428 PRECONDITION_REQUIRED,429 TOO_MANY_REQUESTS,431 REQUEST_HEADER_FIELDS_TOO_LARGE,451 UNAVAILABLE_FOR_LEGAL_REASONS,500 INTERNAL_SERVER_ERROR,501 NOT_IMPLEMENTED,502 BAD_GATEWAY,503 SERVICE_UNAVAILABLE,504 GATEWAY_TIMEOUT,505 HTTP_VERSION_NOT_SUPPORTED,506 VARIANT_ALSO_NEGOTIATES,507 INSUFFICIENT_STORAGE,508 LOOP_DETECTED,509 BANDWIDTH_LIMIT_EXCEEDED,510 NOT_EXTENDED,511 NETWORK_AUTHENTICATION_REQUIRED]The status code value
Status Code
OK
Unauthorized Access
Forbidden Access
Endpoint Not Found
{ "body": { "name": "common-demo-legaltag", "contractId": "AE12345", "expirationDate": "2022-12-21" }, "statusCode": "{'100':'CONTINUE'}", "statusCodeValue": 504 }
Request
Custom Headers
Tenant identifier
Allowable values: [
*/*,application/json]
Requested tags
Legal tag names
curl -k -X POST -H "data-partition-id: {partition_id}" -d '{ "names": [ "string" ] }' "https://{cpd_cluster_host}{:port}/osdu-legal/api/legal/v1/legaltags:batchRetrieve"
Response
Status Code
OK
Created
Unauthorized Access
Forbidden Access
Endpoint Not Found
{ "legalTags": [ { "description": "This is the description of legal tag", "name": "legal-tag-name", "properties": { "contractId": "legal-contract-id", "countryOfOrigin": [ "[USA,CANADA,UK]" ], "dataType": "Public Domain Data", "expirationDate": "yyyy-MM-dd", "exportClassification": "EAR99", "originator": "ODI", "personalData": "Personal Data", "securityClassification": "Public" } } ] }{ "_messageCode_": "201", "message": "Created" }
Request
Custom Headers
Tenant identifier
curl -k -X GET -H "data-partition-id: {partition_id}" "https://{cpd_cluster_host}{:port}/osdu-legal/api/legal/v1/legaltags:properties"
Response
The country of origin
- countriesOfOrigin
The type of datas
The export class number
The other relevant countries related with data
- otherRelevantDataCountries
Personal data types
Security classes
Status Code
OK
Unauthorized Access
Forbidden Access
Endpoint Not Found
{ "countriesOfOrigin": { "additionalProp1": "{'PT':'Portugal','PW':'Palau','QA':'Qatar'}", "additionalProp2": "other-properties", "additionalProp3": "other-properties" }, "dataTypes": [ "[Personally identifiable,Public data]" ], "exportClassificationControlNumbers": [ "[No License Required,Not - Technical Data,EAR99]" ], "otherRelevantDataCountries": { "additionalProp1": "{'PT':'Portugal','PW':'Palau','QA':'Qatar'}" }, "personalDataTypes": [ "[Personally identifiable,Public data]" ], "securityClassifications": [ "[Private,Public,Confedential]" ] }
Request
Custom Headers
Tenant identifier
reference
Allowable values: [
*/*,application/json]
curl -k -X POST -H "data-partition-id: {partition_id}" -H "frame-of-reference: {reference_id}" "https://{cpd_cluster_host}{:port}/osdu-legal/api/legal/v1/push-handlers/legaltag-changed"
Response
- body
Legal tag name
The contract identity
The expiration date
The response status code
Possible values: [
100 CONTINUE,101 SWITCHING_PROTOCOLS,102 PROCESSING,103 CHECKPOINT,200 OK,201 CREATED,202 ACCEPTED,203 NON_AUTHORITATIVE_INFORMATION,204 NO_CONTENT,205 RESET_CONTENT,206 PARTIAL_CONTENT,207 MULTI_STATUS,208 ALREADY_REPORTED,226 IM_USED,300 MULTIPLE_CHOICES,301 MOVED_PERMANENTLY,302 FOUND,302 MOVED_TEMPORARILY,303 SEE_OTHER,304 NOT_MODIFIED,305 USE_PROXY,307 TEMPORARY_REDIRECT,308 PERMANENT_REDIRECT,400 BAD_REQUEST,401 UNAUTHORIZED,402 PAYMENT_REQUIRED,403 FORBIDDEN,404 NOT_FOUND,405 METHOD_NOT_ALLOWED,406 NOT_ACCEPTABLE,407 PROXY_AUTHENTICATION_REQUIRED,408 REQUEST_TIMEOUT,409 CONFLICT,410 GONE,411 LENGTH_REQUIRED,412 PRECONDITION_FAILED,413 PAYLOAD_TOO_LARGE,413 REQUEST_ENTITY_TOO_LARGE,414 URI_TOO_LONG,414 REQUEST_URI_TOO_LONG,415 UNSUPPORTED_MEDIA_TYPE,416 REQUESTED_RANGE_NOT_SATISFIABLE,417 EXPECTATION_FAILED,418 I_AM_A_TEAPOT,419 INSUFFICIENT_SPACE_ON_RESOURCE,420 METHOD_FAILURE,421 DESTINATION_LOCKED,422 UNPROCESSABLE_ENTITY,423 LOCKED,424 FAILED_DEPENDENCY,426 UPGRADE_REQUIRED,428 PRECONDITION_REQUIRED,429 TOO_MANY_REQUESTS,431 REQUEST_HEADER_FIELDS_TOO_LARGE,451 UNAVAILABLE_FOR_LEGAL_REASONS,500 INTERNAL_SERVER_ERROR,501 NOT_IMPLEMENTED,502 BAD_GATEWAY,503 SERVICE_UNAVAILABLE,504 GATEWAY_TIMEOUT,505 HTTP_VERSION_NOT_SUPPORTED,506 VARIANT_ALSO_NEGOTIATES,507 INSUFFICIENT_STORAGE,508 LOOP_DETECTED,509 BANDWIDTH_LIMIT_EXCEEDED,510 NOT_EXTENDED,511 NETWORK_AUTHENTICATION_REQUIRED]The status code value
Status Code
OK
Created
Unauthorized
Forbidden
Not Found
{ "body": { "name": "common-demo-legaltag", "contractId": "AE12345", "expirationDate": "2022-12-21" }, "statusCode": "{'100':'CONTINUE'}", "statusCodeValue": 504 }{ "_messageCode_": "201", "message": "Created" }
Request
Custom Headers
Tenant identifier
Example:
osdu
{
"schema-Info": {
"schemaIdentity": {
"authority": "osdu",
"source": "wks",
"entityType": "wellbore",
"schemaVersionMajor": 1,
"schemaVersionMinor": 0,
"schemaVersionPatch": 0
},
"status": "PUBLISHED"
},
"schema": {}
}Schema info, including status, creation, and Schema-Identity
curl -k -X POST https://{HOSTNAME}:{PORT_NUMBER}/osdu-schema/api/schema/v1/schema -H 'content-type: application/json' -H 'data-partition-id: {partition_id}' -d '{ "schema-Info": { "schemaIdentity": { "authority": "osdu", "source": "wks", "entityType": "wellbore", "schemaVersionMajor": 1, "schemaVersionMinor": 0, "schemaVersionPatch": 0 }, "status": "PUBLISHED" }, "schema": {} }'
Response
Schema info, including status, creation, and Schema-Identity
Schema lifecycle status
Possible values: [
PUBLISHED,OBSOLETE,DEVELOPMENT]The user who created the schema. This value is taken from the API caller token.
Example:
user@opendes.comThe UTC date time of the entity creation
Example:
2019-05-23T11:16:03.000ZSchema authority source and type description
Scope of the schema, which can be internal or shared. This is a system-defined attribute based on the partition-id passed.
Possible values: [
INTERNAL,SHARED]Example:
INTERNALSchema authority source and type description
Status Code
Schema created
Input error. Mandatory fields missing or invalid value passed to API
Unknown or invalid user
User not authorised to access the API
{ "createdBy": "user@opendes.com", "dateCreated": {}, "schemaIdentity": { "authority": "osdu", "entityType": "wellbore", "id": "osdu:wks:wellbore:1.0.0", "schemaVersionMajor": 1, "schemaVersionMinor": 1, "schemaVersionPatch": 0, "source": "wks" }, "scope": "INTERNAL", "status": "PUBLISHED", "supersededBy": { "authority": "osdu", "entityType": "wellbore", "id": "osdu:wks:wellbore:1.0.0", "schemaVersionMajor": 1, "schemaVersionMinor": 1, "schemaVersionPatch": 0, "source": "wks" } }
Request
Custom Headers
Tenant identifier
Example:
osdu
Schema description and schema to update or add
{
"schema-Info": {
"schemaIdentity": {
"authority": "osdu",
"source": "wks",
"entityType": "wellbore",
"schemaVersionMajor": 1,
"schemaVersionMinor": 0,
"schemaVersionPatch": 0
},
"status": "PUBLISHED"
},
"schema": {}
}Schema info, including status, creation, and Schema-Identity
curl -k -X PUT https://{HOSTNAME}:{PORT_NUMBER}/osdu-schema/api/schema-service/v1/api/schema-service/v1/schema -H 'Content-Type: application/json' -H 'data-partition-id: opendes' -d '{ "schemaInfo": { "schemaIdentity": { "authority": "SchemaSanityTest", "source": "testSource", "entityType": "testEntity_279688", "schemaVersionMajor": 2, "schemaVersionMinor": 2, "schemaVersionPatch": 0, "id": "SchemaSanityTest:testSource:testEntity_279688:1.1.0" }, "status": "DEVELOPMENT" }, "schema": { "$schema":"http://json-schema.org/draft-07/schema#", "x-slb-lifecycle-state":"published", "description":"Theentitywell.", "title":"Well", "type":"object", "definitions":{ }, "properties":{ "locationOriginalCRS":{ "description":"Thewell'\''soriginallocationasAnyCrsFeatureCollection -astructuresimilartobutdistinctfromGeoJSON.", "title":"OriginalCRSLocation", "$ref":"#/definition/anyCrsFeatureCollection.1.0" }, "allOf":{ "$ref":"#/definition/slb..wks..well.1.0" }, "locationWGS84":{ "description":"Thewell'\''slocationasGeoJSONFeatureCollection.", "title":"WGS84Location", "$ref":"https://geojson.org/schema/FeatureCollection.json", "example":{ "features":[ { "geometry":{ "coordinates":[ -92.11569999999999, 29.8823, 153.4779442519685 ], "type":"Point" }, "type":"Feature", "properties":{ "name":"Newton2-31" } } ], "type":"FeatureCollection" } } } } }'
Response
Schema info, including status, creation, and Schema-Identity
Schema lifecycle status
Possible values: [
PUBLISHED,OBSOLETE,DEVELOPMENT]The user who created the schema. This value is taken from the API caller token.
Example:
user@opendes.comThe UTC date time of the entity creation
Example:
2019-05-23T11:16:03.000ZSchema authority source and type description
Scope of the schema, which can be internal or shared. This is a system-defined attribute based on the partition-id passed.
Possible values: [
INTERNAL,SHARED]Example:
INTERNALSchema authority source and type description
Status Code
Schema updated
Schema created
Input error. Mandatory fields missing or invalid value passed to API
Unknown or invalid user
User not authorised to access the API
{ "createdBy": "user@opendes.com", "dateCreated": {}, "schemaIdentity": { "authority": "osdu", "entityType": "wellbore", "id": "osdu:wks:wellbore:1.0.0", "schemaVersionMajor": 1, "schemaVersionMinor": 1, "schemaVersionPatch": 0, "source": "wks" }, "scope": "INTERNAL", "status": "PUBLISHED", "supersededBy": { "authority": "osdu", "entityType": "wellbore", "id": "osdu:wks:wellbore:1.0.0", "schemaVersionMajor": 1, "schemaVersionMinor": 1, "schemaVersionPatch": 0, "source": "wks" } }{ "createdBy": "user@opendes.com", "dateCreated": {}, "schemaIdentity": { "authority": "osdu", "entityType": "wellbore", "id": "osdu:wks:wellbore:1.0.0", "schemaVersionMajor": 1, "schemaVersionMinor": 1, "schemaVersionPatch": 0, "source": "wks" }, "scope": "INTERNAL", "status": "PUBLISHED", "supersededBy": { "authority": "osdu", "entityType": "wellbore", "id": "osdu:wks:wellbore:1.0.0", "schemaVersionMajor": 1, "schemaVersionMinor": 1, "schemaVersionPatch": 0, "source": "wks" } }
Request
Custom Headers
Tenant identifier
Example:
osdu
Query Parameters
Pass an optional string to search for a specific authority
Default:
*Example:
osduPass an optional string to search for a specific source
Default:
*Example:
wksPass an optional string to search for a specific entityType
Default:
*Example:
wellborePass an optional string to search for a specific schemaVersionMajor
Default:
*Example:
1Pass an optional string to search for a specific schemaVersionMinor
Default:
*Example:
1The schema status specification
Allowable values: [
PUBLISHED,DEVELOPMENT,OBSOLETE]Default:
PUBLISHEDExample:
PUBLISHEDThe scope or schema visibility specification
Allowable values: [
SHARED,INTERNAL]Default:
INTERNALExample:
INTERNALIf true, only return the latest version
Default:
falseExample:
trueMaximum number of schema records to return
Possible values: 0 ≤ value ≤ 100
Example:
10Number of records to skip for pagination
Possible values: value ≥ 0
Response
The response for a GET schema request
Schema info, including status, creation, and Schema-Identity
The offset for the next query
Possible values: value ≥ 0
The number of schema versions in this response
Possible values: value ≥ 0
The total number of entity type codes in the repository
Possible values: value ≥ 0
Status Code
Successful response
Input error. Mandatory fields missing or invalid value passed to API
Unknown or invalid user
User not authorised to access the API
{ "schemaInfos": [ { "createdBy": "user@opendes.com", "dateCreated": {}, "schemaIdentity": { "authority": "osdu", "entityType": "wellbore", "id": "osdu:wks:wellbore:1.0.0", "schemaVersionMajor": 1, "schemaVersionMinor": 1, "schemaVersionPatch": 0, "source": "wks" }, "scope": "INTERNAL", "status": "PUBLISHED", "supersededBy": { "authority": "osdu", "entityType": "wellbore", "id": "osdu:wks:wellbore:1.0.0", "schemaVersionMajor": 1, "schemaVersionMinor": 1, "schemaVersionPatch": 0, "source": "wks" } } ], "offset": 0, "count": 0, "totalCount": 0 }
Get a specific schema
Get a schema from the schema repository by providing an identifier.
GET /schema/{id}Request
Custom Headers
Tenant identifier
Example:
osdu
Path Parameters
The system ID of the schema
Example:
osdu:wks:wellbore:1.0.0
curl -k -X GET 'https://{HOSTNAME}:{PORT_NUMBER}/osdu-schema/api/schema-service/v1/api/schema-service/v1/schema/SchemaSanityTest:testSource:testEntity_279688:1.1.0' -H 'Content-Type: application/json' -H 'data-partition-id: opendes'
Response
Status Code
search results matching criteria
Input error. Mandatory fields missing or invalid value passed to API
Unknown or invalid user
User not authorised to access the API
Requested Schema not found in repository
{ "$schema": "http://json-schema.org/draft-07/schema#", "description": "The entity shapefile.", "title": "ShapeFile", "type": "object", "definitions": {}, "properties": {} }
Queries which are using the criteria for cross cluster search
The API supports cross cluster searches when given the list of partitions.
POST /ccs/query
Request
Custom Headers
Tenant identifier. This should be same value as first field in kind field
Allowable values: [
*/*,application/json]
Query request
kind to search
The maximum number of results to return from the given offset. If no limit is provided, then it will return 10 items. Max number of items which can be fetched by the query is 100. (If you wish to fetch large set of items, please use query_with_cursor API)
The starting offset from which to return results.
The query string in Lucene query string syntax.
The queryAsOwner switches between viewer and owner to return results that you are entitled to view or results you are the owner of.
curl -k -X POST -H "data-partition-id: {partition_id}" -d '{ "kind": "common:ihs:well:1.0.0", "limit": 30, "offset": 0, "query": "string", "queryAsOwner": false }' "https://{cpd_cluster_host}{:port}/osdu-search/api/search/v2/ccs/query"
Response
The query result
- results
- any property
The total count of elements in response
Status Code
Success
Created
Invalid parameters were given on request
Unauthorized
User not authorized to perform the action
Endpoint Not Found
Search service scale-up is taking longer than expected. Wait 10 seconds and retry.
{ "results": [ { "additionalProp1": {}, "additionalProp2": {}, "additionalProp3": {} } ], "totalCount": 0 }{ "_messageCode_": "201", "message": "Created" }
Queries which are using the input criteria
The API supports full text search on string fields, range queries on date, numeric or string fields, along with geo-spatial search. Required roles: ''users.datalake.viewers'' or ''users.datalake.editors'' or ''users.datalake.admins'' or ''users.datalake.ops''. In addition, users must be a member of data groups to access the data.
POST /query
Request
Custom Headers
Tenant identifier. This should be same value as first field in kind field
Allowable values: [
*/*,application/json]
Query request
''kind'' to search
The maximum number of results to return from the given offset. If no limit is provided, then it will return 10 items. Max number of items which can be fetched by the query is 100. (If you wish to fetch large set of items, please use query_with_cursor API)
The starting offset from which to return results.
The query string in Lucene query string syntax.
The queryAsOwner switches between viewer and owner to return results that you are entitled to view or results you are the owner of.
The fields on which to project the results.
curl -k -X POST -H "data-partition-id: {partition_id}" -d '{ "kind": "common:ihs:well:1.0.0", "limit": 30, "offset": 0, "query": "string", "queryAsOwner": false, "returnedFields": [ "string" ], "sort": { "field": [ "string" ], "order": [ "ASC" ] }, "spatialFilter": { "byBoundingBox": { "bottomRight": { "latitude": 37.450727, "longitude": -122.174762 }, "topLeft": { "latitude": 37.450727, "longitude": -122.174762 } }, "byDistance": { "distance": 1500, "point": { "latitude": 37.450727, "longitude": -122.174762 } }, "byGeoPolygon": { "points": [ { "latitude": 37.450727, "longitude": -122.174762 } ] }, "field": "string" } }' "https://{cpd_cluster_host}{:port}/osdu-search/api/search/v2/query"
Response
Aggregated response
The query result
- results
- any property
The total count of elements in response
Status Code
Success
Created
Invalid parameters were given on request
Unauthorized Access
User not authorized to perform the action
Endpoint Not Found
Search service scale-up is taking longer than expected. Wait 10 seconds and retry.
{ "aggregations": [ { "count": 12, "key": "key-id" } ], "results": [ { "additionalProp1": {}, "additionalProp2": {}, "additionalProp3": {} } ], "totalCount": 10 }{ "_messageCode_": "201", "message": "Created" }
Queries which are using the input criteria with cursor
The API supports full text search on string fields, range queries on date, numeric or string fields, along with geo-spatial search. Required roles: ''users.datalake.viewers'' or ''users.datalake.editors'' or ''users.datalake.admins'' or ''users.datalake.ops''. In addition, users must be a member of data groups to access the data. It can be used to retrieve large numbers of results (or even all results) from a single search request, in much the same way as you would use a cursor on a traditional database.
POST /query_with_cursor
Request
Custom Headers
Tenant identifier. This should be same value as first field in kind field
Allowable values: [
*/*,application/json]
Query request
'''kind'' to search'
Search context to retrieve next batch of results.
The maximum number of results to return from the given offset. If no limit is provided, then it will return 10 items. Max number of items which can be fetched by the query is 100. (If you wish to fetch large set of items, please use query_with_cursor API)
The query string in Lucene query string syntax.
The queryAsOwner switches between viewer and owner to return results that you are entitled to view or results you are the owner of.
The fields on which to project the results.
curl -k -X POST -H "data-partition-id: {partition_id}" -d '{ "kind": "common:ihs:well:1.0.0", "limit": 30, "query": "string", "queryAsOwner": false, "returnedFields": [ "string" ], "sort": { "field": [ "string" ], "order": [ "ASC" ] }, "spatialFilter": { "byBoundingBox": { "bottomRight": { "latitude": 37.450727, "longitude": -122.174762 }, "topLeft": { "latitude": 37.450727, "longitude": -122.174762 } }, "byDistance": { "distance": 1500, "point": { "latitude": 37.450727, "longitude": -122.174762 } }, "byGeoPolygon": { "points": [ { "latitude": 37.450727, "longitude": -122.174762 } ] }, "field": "string" } }' "https://{cpd_cluster_host}{:port}/osdu-search/api/search/v2/query_with_cursor"
Response
The cursor marker in query
The query result
- results
- any property
The total count of elements in response
Status Code
Success
Created
Invalid parameters were given on request
Unauthorized Access
User not authorized to perform the action
Endpoint Not Found
Search service scale-up is taking longer than expected. Wait 10 seconds and retry.
{ "cursor": "string", "results": [ { "additionalProp1": {}, "additionalProp2": {}, "additionalProp3": {} } ], "totalCount": 10 }{ "_messageCode_": "201", "message": "Created" }
Request
Custom Headers
Tenant identifier
reference
Query Parameters
kind
cursor
limit
curl -k -X GET -H "data-partition-id: {partition_id}" -H "frame-of-reference: {reference_id}" "https://{cpd_cluster_host}{:port}/osdu-storage/api/storage/v2/query/records?kind={string}&cursor={string}&limit={integer}"
Request
Custom Headers
Tenant identifier
reference
Allowable values: [
*/*,application/json]
ids
The record identity array
curl -k -X POST -H "data-partition-id: {partition_id}" -H "frame-of-reference: {reference_id}" -d '{ "attributes": [ "string" ], "records": [ "string" ] }' "https://{cpd_cluster_host}{:port}/osdu-storage/api/storage/v2/query/records"
Response
The invalid record identity array
The record identity array
The retry record identity array
Status Code
OK
Created
Unauthorized
Forbidden
Not Found
{ "invalidRecords": [ "[opendes:doc:6d29c781d5484e1dbc34d392f58cd055,opendes:doc:6d29c781d5484e1dbc34d392f58cd034,opendes:doc:6d29c781d5484e1dbc34d392f58cd067,opendes:doc:6d29c781d5484e1dbc34d392f58cd078]" ], "records": [ { "data": { "ResourceID": "srn:master-data/Well:2492:", "ResourceTypeID": "srn:type:master-data/Well:", "ResourceSecurityClassification": "srn:reference-data/ResourceSecurityClassification:PUBLIC:", "Data": { "IndividualTypeProperties": { "FacilityOperator": [ { "FacilityOperatorOrganisationID": "srn:master-data/Organisation:nam:" } ], "DataSourceOrganisationID": "srn:master-data/Organisation:tno:", "SpatialLocation": [ { "Coordinates": [ { "x": 6.91700948, "y": 52.65622264 } ], "SpatialGeometryTypeID": "srn:reference-data/SpatialGeometryType:point:", "VerticalCRSID": "srn:reference-data/VerticalCRS:nap:", "HorizontalCRSID": "srn:reference-data/HorizontalCRS:WGS84:", "HeightAboveGroundLevelUOMID": "srn:reference-data/UnitOfMeasure:m:" } ], "FacilityName": "SCH-586", "FacilityNameAlias": [ { "AliasName": "SCH-586", "AliasNameTypeID": "srn:reference-data/AliasNameType:name:" }, { "AliasName": "2492", "AliasNameTypeID": "srn:reference-data/AliasNameType:UWI:" } ], "FacilityState": [ { "FacilityStateTypeID": "srn:reference-data/FacilityStateType:Abandoned:" } ], "FacilityEvent": [ { "FacilityEventTypeID": "srn:reference-data/FacilityEventType:spud:", "EffectiveDateTime": "1984-09-16T00:00:00" }, { "FacilityEventTypeID": "srn:reference-data/FacilityEventType:DRILLING FINISH:", "EffectiveDateTime": "1984-10-03T00:00:00" } ], "DefaultVerticalMeasurementID": "Rotary Table", "VerticalMeasurements": [ { "VerticalMeasurementID": "Rotary Table", "VerticalMeasurementTypeID": "srn:reference-data/VerticalMeasurementType:Rotary Table:", "VerticalMeasurement": 20, "VerticalMeasurementPathID": "srn:reference-data/VerticalMeasurementPath:Elevation:", "VerticalMeasurementUnitOfMeasureID": "srn:reference-data/UnitOfMeasure:m:", "VerticalCRSID": "srn:reference-data/VerticalCRS:nap:" } ], "OperatingEnvironmentID": "srn:reference-data/WellOperatingEnvironment:on:", "CountryID": "srn:master-data/GeopoliticalEntity:Netherlands:", "StateProvinceID": "srn:master-data/GeopoliticalEntity:Drenthe:", "QuadrantID": "srn:master-data/GeopoliticalEntity:d:" } }, "meta": null, "id": "opendes:doc:0f23276e96274461872adcb222f1ef1d", "version": 1599141178852896, "kind": "opendes:osdu-r2-core:test:1.0.0", "acl": { "viewers": [ "data.default.viewers@opendes.ibm.com" ], "owners": [ "data.default.owners@opendes.ibm.com" ] }, "legal": { "legaltags": [ "opendes-public-usa-dataset-1" ], "otherRelevantDataCountries": [ "US" ], "status": "compliant" }, "createUser": "osdu-dev@odi.ibm.com", "createTime": "2020-09-03T13:53:00.719Z" } } ], "retryRecords": [ "[opendes:doc:6d29c781d5484e1dbc34d392f58cd055,opendes:doc:6d29c781d5484e1dbc34d392f58cd034,opendes:doc:6d29c781d5484e1dbc34d392f58cd067,opendes:doc:6d29c781d5484e1dbc34d392f58cd078]" ] }{ "_messageCode_": "201", "message": "Created" }
Request
Custom Headers
Tenant identifier
reference
Allowable values: [
*/*,application/json]
ids
The record identity array
curl -k -X POST -H "data-partition-id: {partition_id}" -H "frame-of-reference: {reference_id}" -d '{ "records": [ "string" ] }' "https://{cpd_cluster_host}{:port}/osdu-storage/api/storage/v2/query/records:batch"
Response
The conversion status array
The not found response array
The record identity array
Status Code
OK
Created
Unauthorized
Forbidden
Not Found
{ "conversionStatuses": [ { "errors": [ "[value invalid,value not present]" ], "id": "AE12345", "status": "Invalid" } ], "notFound": [ "[opendes:doc:6d29c781d5484e1dbc34d392f58cd055,opendes:doc:6d29c781d5484e1dbc34d392f58cd034,opendes:doc:6d29c781d5484e1dbc34d392f58cd067,opendes:doc:6d29c781d5484e1dbc34d392f58cd078]" ], "records": [ { "data": { "ResourceID": "srn:master-data/Well:2492:", "ResourceTypeID": "srn:type:master-data/Well:", "ResourceSecurityClassification": "srn:reference-data/ResourceSecurityClassification:PUBLIC:", "Data": { "IndividualTypeProperties": { "FacilityOperator": [ { "FacilityOperatorOrganisationID": "srn:master-data/Organisation:nam:" } ], "DataSourceOrganisationID": "srn:master-data/Organisation:tno:", "SpatialLocation": [ { "Coordinates": [ { "x": 6.91700948, "y": 52.65622264 } ], "SpatialGeometryTypeID": "srn:reference-data/SpatialGeometryType:point:", "VerticalCRSID": "srn:reference-data/VerticalCRS:nap:", "HorizontalCRSID": "srn:reference-data/HorizontalCRS:WGS84:", "HeightAboveGroundLevelUOMID": "srn:reference-data/UnitOfMeasure:m:" } ], "FacilityName": "SCH-586", "FacilityNameAlias": [ { "AliasName": "SCH-586", "AliasNameTypeID": "srn:reference-data/AliasNameType:name:" }, { "AliasName": "2492", "AliasNameTypeID": "srn:reference-data/AliasNameType:UWI:" } ], "FacilityState": [ { "FacilityStateTypeID": "srn:reference-data/FacilityStateType:Abandoned:" } ], "FacilityEvent": [ { "FacilityEventTypeID": "srn:reference-data/FacilityEventType:spud:", "EffectiveDateTime": "1984-09-16T00:00:00" }, { "FacilityEventTypeID": "srn:reference-data/FacilityEventType:DRILLING FINISH:", "EffectiveDateTime": "1984-10-03T00:00:00" } ], "DefaultVerticalMeasurementID": "Rotary Table", "VerticalMeasurements": [ { "VerticalMeasurementID": "Rotary Table", "VerticalMeasurementTypeID": "srn:reference-data/VerticalMeasurementType:Rotary Table:", "VerticalMeasurement": 20, "VerticalMeasurementPathID": "srn:reference-data/VerticalMeasurementPath:Elevation:", "VerticalMeasurementUnitOfMeasureID": "srn:reference-data/UnitOfMeasure:m:", "VerticalCRSID": "srn:reference-data/VerticalCRS:nap:" } ], "OperatingEnvironmentID": "srn:reference-data/WellOperatingEnvironment:on:", "CountryID": "srn:master-data/GeopoliticalEntity:Netherlands:", "StateProvinceID": "srn:master-data/GeopoliticalEntity:Drenthe:", "QuadrantID": "srn:master-data/GeopoliticalEntity:d:" } }, "meta": null, "id": "opendes:doc:0f23276e96274461872adcb222f1ef1d", "version": 1599141178852896, "kind": "opendes:osdu-r2-core:test:1.0.0", "acl": { "viewers": [ "data.default.viewers@opendes.ibm.com" ], "owners": [ "data.default.owners@opendes.ibm.com" ] }, "legal": { "legaltags": [ "opendes-public-usa-dataset-1" ], "otherRelevantDataCountries": [ "US" ], "status": "compliant" }, "createUser": "osdu-dev@odi.ibm.com", "createTime": "2020-09-03T13:53:00.719Z" } } ], "retryRecords": [ "[opendes:doc:6d29c781d5484e1dbc34d392f58cd056,opendes:doc:6d29c781d5484e1dbc34d392f58cd014,opendes:doc:6d29c781d5484e1dbc34d392f58cd097,opendes:doc:6d29c781d5484e1dbc34d392f58cd058]" ] }{ "_messageCode_": "201", "message": "Created" }
Request
Custom Headers
Tenant identifier
reference
Allowable values: [
*/*,application/json]
Query Parameters
skipdupes
records
Unique identifier in whole Data Ecosystem. When not provided, Data Ecosystem will create and assign an id to the record. Must follow the naming convention: {Data-Partition-Id}:{object-type}:{uuid}.
Record kind for which the schema information is applied to.
The data as object
- data
- meta
- any property
The record version
curl -k -X PUT -H "data-partition-id: {partition_id}" -H "frame-of-reference: {reference_id} -d '[ { "acl": { "owners": [ "string" ], "viewers": [ "string" ] }, "ancestry": { "parents": [ "string" ] }, "data": {}, "id": "common:welldb:123456", "kind": "common:welldb:wellbore:1.0.0", "legal": { "legaltags": [ "string" ], "otherRelevantDataCountries": [ "string" ], "status": "compliant" }, "meta": [ { "additionalProp1": {}, "additionalProp2": {}, "additionalProp3": {} } ], "version": 0 } ]' "https://{cpd_cluster_host}{:port}/osdu-storage/api/storage/v2/records"
Response
The records count
Example:
12The records identity
The skip records identity
Status Code
OK
Created
Unauthorized
Forbidden
Not Found
{ "recordCount": 12, "recordIds": [ "[opendes:doc:6d29c781d5484e1dbc34d392f58cd055,opendes:doc:6d29c781d5484e1dbc34d392f58cd034,opendes:doc:6d29c781d5484e1dbc34d392f58cd067,opendes:doc:6d29c781d5484e1dbc34d392f58cd078]" ], "skippedRecordIds": [ "[opendes:doc:6d29c781d5484e1dbc34d392f58cd058,opendes:doc:6d29c781d5484e1dbc34d392f58cd036,opendes:doc:6d29c781d5484e1dbc34d392f58cd017]" ] }{ "_messageCode_": "201", "message": "Created" }
Request
Custom Headers
Tenant identifier
reference
Allowable values: [
*/*,application/json]
Record bulk update param
Record metadata operations.
curl -k -X PATCH -H "data-partition-id: {partition_id}" -H "frame-of-reference: {reference_id} -d '{ "ops": [ { "op": "replace", "path": "/acl/owners", "value": [ "string" ] } ], "query": { "ids": "common:welldb:123456" } }' "https://{cpd_cluster_host}{:port}/osdu-storage/api/storage/v2/query/records"
Response
The locked records identity
The not found records identity
The records count
The records identity
The unauthorized records identity
Status Code
OK
No Content
Unauthorized
Forbidden
{ "lockedRecordIds": [ "[A12345,X45678,Y45678]" ], "notFoundRecordIds": [ "[A12349,X45671,Y45673]" ], "recordCount": 121, "recordIds": [ "[A12345,X45678,Y45678]" ], "unAuthorizedRecordIds": [ "[A12346,X45688,Y45768]" ] }{ "_messageCode_": "204", "message": "No Content" }
Request
Custom Headers
The file type or format of the request body
Tenant identifier
Allowable values: [
*/*,application/json]
request
curl -k -X POST https://{HOSTNAME}:{PORT_NUMBER}/osdu-workflow/api/workflow/v1/workflow -H 'content-type: application/json' -H "data-partition-id: {partition_id}" -d '{ "description": "This is csv parser workflow", "registrationInstructions": {}, "workflowName": "{{workflow_name}}" }'
Request
Custom Headers
The file type or format of the request body
Tenant identifier
Path Parameters
Workflow name
Query Parameters
Set of parameters that filter instances
curl -k -X GET https://{HOSTNAME}:{PORT_NUMBER}/osdu-workflow/api/workflow/v1/workflow/{{workflow_name}}/workflowRun -H 'content-type: application/json' -H "data-partition-id: {partition_id}"
Request
Custom Headers
The file type or format of the request body
Tenant identifier
Allowable values: [
*/*,application/json]
Path Parameters
Workflow name
Request body structure
curl -k -X POST https://{HOSTNAME}:{PORT_NUMBER}/osdu-workflow/api/workflow/v1/workflow/{{workflow_name}}/workflowRun -H 'content-type: application/json' -H "data-partition-id: {partition_id}" -d '{ "executionContext": {"data-partition-id": "opendes"}, "runId": "{{runid}}" }'
Request
Custom Headers
The file type or format of the request body
Tenant identifier
Path Parameters
Run ID
Workflow name
curl -k -X GET https://{HOSTNAME}:{PORT_NUMBER}/osdu-workflow/api/workflow/v1/workflow/{{workflow_name}}/workflowRun/{{runid}} -H 'content-type: application/json' -H "data-partition-id: {partition_id}"
Request
Custom Headers
The file type or format of the request body
Tenant identifier
Allowable values: [
*/*,application/json]
Path Parameters
Run ID
Workflow name
Request body structure
Allowable values: [
SUBMITTED,RUNNING,FINISHED,FAILED,SUCCESS]
curl -k -X PUT https://{HOSTNAME}:{PORT_NUMBER}/osdu-workflow/api/workflow/v1/workflow/{{workflow_name}}/workflowRun/{{runid}} -H 'content-type: application/json' -H "data-partition-id: {partition_id}" -d '{ "status": "submitted" }'
Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
curl -k -X GET 'https://{HOSTNAME}:{PORT_NUMBER}/osdu-wellbore/api/os-wellbore-ddms/ddms/v2/status' -H 'Authorization: Bearer {{token}}'
Response
The base model forbids fields which are not declared initially in the pydantic model
The base model forbids fields which are not declared initially in the pydantic model
The base model forbids fields which are not declared initially in the pydantic model
Status Code
Successful Response
Validation Error
No Sample Response
Get the Well object by using wks:well:1.0.2 schema
Get the Well object using its id.
If the well kind is wks:well:1.0.2 returns the record directly
If the well kind is different wks:well:1.0.2 it will get the raw record and convert the results to match the wks:well:1.0.2. If convertion is not possible returns an error 500.
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
GET /ddms/v2/wells/{wellid}Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
Response
The base model forbids fields which are not declared initially in the pydantic model
The links to data, which constitute the inputs.
- ancestry
The meta data section linking the 'unitKey', 'crsKey' to self-contained definitions (persistableReference)
The reference entity type as declared in common:metadata:entity:*.
A generic dictionary of string keys mapping to string value. Only strings are permitted as keys and values.
Examples:{ "NameOfKey": "String value" }- tags
Timestamp of the time at which initial version of this OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:46:20.163ZThe user reference, which created the first version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comTimestamp of the time at which this version of the OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:52:24.477ZThe user reference, which created this version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comThe access control tags associated with this entity.
- acl
Well data container
- data
The basin context details for the well.
- basinContext
The code of the basin in which the well is located.
The name of the basin in which the well is located.
The code of the sub-basin in which the well is located.
The name of the sub-basin in which the well is located.
The block name, in which the well is located.
The country, in which the well is located. The country name follows the convention in ISO 3166-1 'English short country name', see https://en.wikipedia.org/wiki/ISO_3166-1
The county name, in which the well is located.
The UTC date time of the entity creation
The UTC date time when the well license was issued.
The UTC date time of the last entity modification
The UTC date and time at which the well was plugged and abandoned.
The date and time when activities to drill the borehole begin to create a hole in the earth. For a sidetrack, this is the date kickoff operations began. The format follows ISO 8601 YYYY-MM-DD extended format
POSC well direction. The direction of the flow of the fluids in a well facility (generally, injected or produced, or some combination).
Possible values: [
huff-n-puff,injector,producer,uncertain,unknown]The district name, to which the well belongs.
The well's elevation reference from mean sea level (MSL), positive above MSL. This is where MD == 0 and TVD == 0
- elevationReference
The elevation above mean sea level (MSL), at which the vertical origin is 0.0. The 'unitKey' is further defined in 'frameOfReference.units'.
- elevationFromMsl
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The name of the Elevation Reference.
An array of identities (e.g. some kind if URL to be resolved in an external data store), which links to external realizations of the same entity.
The field name, to which the well belongs.
POSC well fluid. The type of fluid being produced from or injected \ninto a well facility.
Possible values: [
air,condensate,dry,gas,gas-water,non HC gas,non HC gas -- CO2,oil,oil-gas,oil-water,steam,water,water -- brine,water -- fresh water,unknown]The well's ground elevation, Values above MSL are positive..
- groundElevation
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
A 2D GeoJSON FeatureCollection defining well location or trajectory in WGS 84 CRS.
- locationWGS84
The base model forbids fields which are not declared initially in the pydantic model
An enumeration.
Possible values: [
FeatureCollection]
The well name
The operator company name of the well.
The operator division of the well.
Interest for operator. Commonly in percent.
Original operator of the well. This may be different than the current operator.
A location described by the Public Land Survey System (United States)
- plssLocation
Range, also known as Rng, R; a measure of the distance east or west from a referenced principal meridian, in units of six miles.
Section number (between 1 and 36)
Township, also known as T or Twp; (1) Synonym for survey township, i.e., a square parcel of land of 36 square miles, or (2) A measure of the distance north or south from a referenced baseline, in units of six miles
A terse, hierarchical reference to a piece of land, in which successive subdivisions of some larger area.
A dictionary structure, i.e. key/string value pairs, to carry additional well properties.
Geo-political region in which the well is located.
The related entities.
- relationships
The asset this well belongs to.
- asset
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
The state name, in which the well is located.
The unique well identifier, aka. API number, US well number or UBHI. Codes can have 10, 12 or 14 digits depending on the availability of directional sidetrack (2 digits) and event sequence codes (2 digits).
Depth of water (not land rigs).
- waterDepth
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The well's vertical position is an elevation from mean sea level (MSL), positive above MSL.
- wellHeadElevation
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The well's well head position in the native, geographic CRS; vertical position is an elevation from mean sea level (MSL), positive above MSL.
- wellHeadGeographic
The 'crsKey', which can be looked up in the 'frameOfReference.crs' for further details.
Elevation from Mean Seal Level, downwards negative. The unit definition is found via 'elevationFromMsl.unitKey' in 'frameOfReference.units' dictionary.
- elevationFromMsl
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Native or original latitude (unit defined by CRS)
Native or original longitude (unit defined by CRS)
The well's well head position in the native, projected CRS; vertical position is an elevation from mean sea level (MSL), positive above MSL.
- wellHeadProjected
The 'crsKey', which can be looked up in the 'frameOfReference.crs' for further details.
Elevation from Mean Seal Level, downwards negative. The unit definition is found via 'elevationFromMsl.unitKey' in 'frameOfReference.units' dictionary.
- elevationFromMsl
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
X-coordinate value in native or original projected CRS
Y-coordinate value in native or original projected CRS
The well's position in WGS 84 latitude and longitude.
- wellHeadWgs84
The latitude value in degrees of arc (dega). Value range [-90, 90].
Possible values: -90 ≤ value ≤ 90
The longitude value in degrees of arc (dega). Value range [-180, 180]
Possible values: -180 ≤ value ≤ 180
An enumeration.
Possible values: [
Onshore,Offshore,unknown]Government assigned well number.
License number of the well.
Operator well number.
POSC well purpose
Possible values: [
appraisal,appraisal -- confirmation appraisal,appraisal -- exploratory appraisal,exploration,exploration -- deeper-pool wildcat,exploration -- new-field wildcat,exploration -- new-pool wildcat,exploration -- outpost wildcat,exploration -- shallower-pool wildcat,development,development -- infill development,development -- injector,development -- producer,fluid storage,fluid storage -- gas storage,general srvc,general srvc -- borehole re-acquisition,general srvc -- observation,general srvc -- relief,general srvc -- research,general srvc -- research -- drill test,general srvc -- research -- strat test,general srvc -- waste disposal,mineral,unknown]POSC well status.
Possible values: [
abandoned,active,active -- injecting,active -- producing,completed,drilling,partially plugged,permitted,plugged and abandoned,proposed,sold,suspended,temporarily abandoned,testing,tight,working over,unknown]Type of well.
Possible values: [
bypass,initial,redrill,reentry,respud,sidetrack,unknown]
The unique identifier of the well
Well-known well kind specification
The geological interpretation's legal tags
- legal
The list of legal tags, see compliance API.
The list of other relevant data countries using the ISO 2-letter codes, see compliance API.
The legal status.
The version number of this well; set by the framework.
Status Code
Successful Response
Well not found
Validation Error
No Sample Response
Delete the well. The API performs a logical deletion of the given record
Required roles: 'users.datalake.editors' or 'users.datalake.admins'.
DELETE /ddms/v2/wells/{wellid}Get all versions of the Well
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
GET /ddms/v2/wells/{wellid}/versionsGet the given version of the Well object by using wks:well:1.0.2 schema
"Get the Well object using its id.
If the well kind is wks:well:1.0.2 returns the record directly
If the well kind is different wks:well:1.0.2 it will get the raw record and convert the results to match the wks:well:1.0.2. If convertion is not possible returns an error 500.
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
GET /ddms/v2/wells/{wellid}/versions/{version}Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
Response
The base model forbids fields which are not declared initially in the pydantic model
The links to data, which constitute the inputs.
- ancestry
The meta data section linking the 'unitKey', 'crsKey' to self-contained definitions (persistableReference)
The reference entity type as declared in common:metadata:entity:*.
A generic dictionary of string keys mapping to string value. Only strings are permitted as keys and values.
Examples:{ "NameOfKey": "String value" }- tags
Timestamp of the time at which initial version of this OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:46:20.163ZThe user reference, which created the first version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comTimestamp of the time at which this version of the OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:52:24.477ZThe user reference, which created this version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comThe access control tags associated with this entity.
- acl
Well data container
- data
The basin context details for the well.
- basinContext
The code of the basin in which the well is located.
The name of the basin in which the well is located.
The code of the sub-basin in which the well is located.
The name of the sub-basin in which the well is located.
The block name, in which the well is located.
The country, in which the well is located. The country name follows the convention in ISO 3166-1 'English short country name', see https://en.wikipedia.org/wiki/ISO_3166-1
The county name, in which the well is located.
The UTC date time of the entity creation
The UTC date time when the well license was issued.
The UTC date time of the last entity modification
The UTC date and time at which the well was plugged and abandoned.
The date and time when activities to drill the borehole begin to create a hole in the earth. For a sidetrack, this is the date kickoff operations began. The format follows ISO 8601 YYYY-MM-DD extended format
POSC well direction. The direction of the flow of the fluids in a well facility (generally, injected or produced, or some combination).
Possible values: [
huff-n-puff,injector,producer,uncertain,unknown]The district name, to which the well belongs.
The well's elevation reference from mean sea level (MSL), positive above MSL. This is where MD == 0 and TVD == 0
- elevationReference
The elevation above mean sea level (MSL), at which the vertical origin is 0.0. The 'unitKey' is further defined in 'frameOfReference.units'.
- elevationFromMsl
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The name of the Elevation Reference.
An array of identities (e.g. some kind if URL to be resolved in an external data store), which links to external realizations of the same entity.
The field name, to which the well belongs.
POSC well fluid. The type of fluid being produced from or injected \ninto a well facility.
Possible values: [
air,condensate,dry,gas,gas-water,non HC gas,non HC gas -- CO2,oil,oil-gas,oil-water,steam,water,water -- brine,water -- fresh water,unknown]The well's ground elevation, Values above MSL are positive..
- groundElevation
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
A 2D GeoJSON FeatureCollection defining well location or trajectory in WGS 84 CRS.
- locationWGS84
The base model forbids fields which are not declared initially in the pydantic model
An enumeration.
Possible values: [
FeatureCollection]
The well name
The operator company name of the well.
The operator division of the well.
Interest for operator. Commonly in percent.
Original operator of the well. This may be different than the current operator.
A location described by the Public Land Survey System (United States)
- plssLocation
Range, also known as Rng, R; a measure of the distance east or west from a referenced principal meridian, in units of six miles.
Section number (between 1 and 36)
Township, also known as T or Twp; (1) Synonym for survey township, i.e., a square parcel of land of 36 square miles, or (2) A measure of the distance north or south from a referenced baseline, in units of six miles
A terse, hierarchical reference to a piece of land, in which successive subdivisions of some larger area.
A dictionary structure, i.e. key/string value pairs, to carry additional well properties.
Geo-political region in which the well is located.
The related entities.
- relationships
The asset this well belongs to.
- asset
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
The state name, in which the well is located.
The unique well identifier, aka. API number, US well number or UBHI. Codes can have 10, 12 or 14 digits depending on the availability of directional sidetrack (2 digits) and event sequence codes (2 digits).
Depth of water (not land rigs).
- waterDepth
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The well's vertical position is an elevation from mean sea level (MSL), positive above MSL.
- wellHeadElevation
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The well's well head position in the native, geographic CRS; vertical position is an elevation from mean sea level (MSL), positive above MSL.
- wellHeadGeographic
The 'crsKey', which can be looked up in the 'frameOfReference.crs' for further details.
Elevation from Mean Seal Level, downwards negative. The unit definition is found via 'elevationFromMsl.unitKey' in 'frameOfReference.units' dictionary.
- elevationFromMsl
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Native or original latitude (unit defined by CRS)
Native or original longitude (unit defined by CRS)
The well's well head position in the native, projected CRS; vertical position is an elevation from mean sea level (MSL), positive above MSL.
- wellHeadProjected
The 'crsKey', which can be looked up in the 'frameOfReference.crs' for further details.
Elevation from Mean Seal Level, downwards negative. The unit definition is found via 'elevationFromMsl.unitKey' in 'frameOfReference.units' dictionary.
- elevationFromMsl
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
X-coordinate value in native or original projected CRS
Y-coordinate value in native or original projected CRS
The well's position in WGS 84 latitude and longitude.
- wellHeadWgs84
The latitude value in degrees of arc (dega). Value range [-90, 90].
Possible values: -90 ≤ value ≤ 90
The longitude value in degrees of arc (dega). Value range [-180, 180]
Possible values: -180 ≤ value ≤ 180
An enumeration.
Possible values: [
Onshore,Offshore,unknown]Government assigned well number.
License number of the well.
Operator well number.
POSC well purpose
Possible values: [
appraisal,appraisal -- confirmation appraisal,appraisal -- exploratory appraisal,exploration,exploration -- deeper-pool wildcat,exploration -- new-field wildcat,exploration -- new-pool wildcat,exploration -- outpost wildcat,exploration -- shallower-pool wildcat,development,development -- infill development,development -- injector,development -- producer,fluid storage,fluid storage -- gas storage,general srvc,general srvc -- borehole re-acquisition,general srvc -- observation,general srvc -- relief,general srvc -- research,general srvc -- research -- drill test,general srvc -- research -- strat test,general srvc -- waste disposal,mineral,unknown]POSC well status.
Possible values: [
abandoned,active,active -- injecting,active -- producing,completed,drilling,partially plugged,permitted,plugged and abandoned,proposed,sold,suspended,temporarily abandoned,testing,tight,working over,unknown]Type of well.
Possible values: [
bypass,initial,redrill,reentry,respud,sidetrack,unknown]
The unique identifier of the well
Well-known well kind specification
The geological interpretation's legal tags
- legal
The list of legal tags, see compliance API.
The list of other relevant data countries using the ISO 2-letter codes, see compliance API.
The legal status.
The version number of this well; set by the framework.
Status Code
Successful Response
Well not found
Validation Error
No Sample Response
Create or update the Wells by using wks:well:1.0.2 schema
Required roles: 'users.datalake.editors' or 'users.datalake.admins'.
POST /ddms/v2/wells
Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
The base model forbids fields which are not declared initially in the pydantic model
[
{
"acl": {
"viewers": [
"data.default.viewers@{{datapartitionid}}.{{domain}}.com"
],
"owners": [
"data.default.owners@{{datapartitionid}}.{{domain}}.com"
]
},
"data": {
"name": "myWell",
"uwi": "00-000-00000-00"
},
"id": "{{datapartitionid}}:well:myWell",
"kind": "{{datapartitionid}}:wks:well:1.0.2",
"legal": {
"legaltags": [
"{{legaltags}}"
],
"otherRelevantDataCountries": [
"FR",
"US"
],
"status": "compliant"
}
}
]The links to data, which constitute the inputs.
- ancestry
The meta data section linking the 'unitKey', 'crsKey' to self-contained definitions (persistableReference)
The reference entity type as declared in common:metadata:entity:*.
A generic dictionary of string keys mapping to string value. Only strings are permitted as keys and values.
Examples:{ "NameOfKey": "String value" }- tags
Timestamp of the time at which initial version of this OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:46:20.163ZThe user reference, which created the first version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comTimestamp of the time at which this version of the OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:52:24.477ZThe user reference, which created this version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comThe access control tags associated with this entity.
- acl
Well data container
- data
The basin context details for the well.
- basinContext
The code of the basin in which the well is located.
The name of the basin in which the well is located.
The code of the sub-basin in which the well is located.
The name of the sub-basin in which the well is located.
The block name, in which the well is located.
The country, in which the well is located. The country name follows the convention in ISO 3166-1 'English short country name', see https://en.wikipedia.org/wiki/ISO_3166-1
The county name, in which the well is located.
The UTC date time of the entity creation
The UTC date time when the well license was issued.
The UTC date time of the last entity modification
The UTC date and time at which the well was plugged and abandoned.
The date and time when activities to drill the borehole begin to create a hole in the earth. For a sidetrack, this is the date kickoff operations began. The format follows ISO 8601 YYYY-MM-DD extended format
POSC well direction. The direction of the flow of the fluids in a well facility (generally, injected or produced, or some combination).
Allowable values: [
huff-n-puff,injector,producer,uncertain,unknown]The district name, to which the well belongs.
The well's elevation reference from mean sea level (MSL), positive above MSL. This is where MD == 0 and TVD == 0
- elevationReference
The elevation above mean sea level (MSL), at which the vertical origin is 0.0. The 'unitKey' is further defined in 'frameOfReference.units'.
- elevationFromMsl
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The name of the Elevation Reference.
An array of identities (e.g. some kind if URL to be resolved in an external data store), which links to external realizations of the same entity.
The field name, to which the well belongs.
POSC well fluid. The type of fluid being produced from or injected \ninto a well facility.
Allowable values: [
air,condensate,dry,gas,gas-water,non HC gas,non HC gas -- CO2,oil,oil-gas,oil-water,steam,water,water -- brine,water -- fresh water,unknown]The well's ground elevation, Values above MSL are positive..
- groundElevation
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
A 2D GeoJSON FeatureCollection defining well location or trajectory in WGS 84 CRS.
- locationWGS84
The base model forbids fields which are not declared initially in the pydantic model
An enumeration.
Allowable values: [
FeatureCollection]
The well name
The operator company name of the well.
The operator division of the well.
Interest for operator. Commonly in percent.
Original operator of the well. This may be different than the current operator.
A location described by the Public Land Survey System (United States)
- plssLocation
Range, also known as Rng, R; a measure of the distance east or west from a referenced principal meridian, in units of six miles.
Section number (between 1 and 36)
Township, also known as T or Twp; (1) Synonym for survey township, i.e., a square parcel of land of 36 square miles, or (2) A measure of the distance north or south from a referenced baseline, in units of six miles
A terse, hierarchical reference to a piece of land, in which successive subdivisions of some larger area.
A dictionary structure, i.e. key/string value pairs, to carry additional well properties.
Geo-political region in which the well is located.
The related entities.
- relationships
The asset this well belongs to.
- asset
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
The state name, in which the well is located.
The unique well identifier, aka. API number, US well number or UBHI. Codes can have 10, 12 or 14 digits depending on the availability of directional sidetrack (2 digits) and event sequence codes (2 digits).
Depth of water (not land rigs).
- waterDepth
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The well's vertical position is an elevation from mean sea level (MSL), positive above MSL.
- wellHeadElevation
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The well's well head position in the native, geographic CRS; vertical position is an elevation from mean sea level (MSL), positive above MSL.
- wellHeadGeographic
The 'crsKey', which can be looked up in the 'frameOfReference.crs' for further details.
Elevation from Mean Seal Level, downwards negative. The unit definition is found via 'elevationFromMsl.unitKey' in 'frameOfReference.units' dictionary.
- elevationFromMsl
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Native or original latitude (unit defined by CRS)
Native or original longitude (unit defined by CRS)
The well's well head position in the native, projected CRS; vertical position is an elevation from mean sea level (MSL), positive above MSL.
- wellHeadProjected
The 'crsKey', which can be looked up in the 'frameOfReference.crs' for further details.
Elevation from Mean Seal Level, downwards negative. The unit definition is found via 'elevationFromMsl.unitKey' in 'frameOfReference.units' dictionary.
- elevationFromMsl
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
X-coordinate value in native or original projected CRS
Y-coordinate value in native or original projected CRS
The well's position in WGS 84 latitude and longitude.
- wellHeadWgs84
The latitude value in degrees of arc (dega). Value range [-90, 90].
Possible values: -90 ≤ value ≤ 90
The longitude value in degrees of arc (dega). Value range [-180, 180]
Possible values: -180 ≤ value ≤ 180
An enumeration.
Allowable values: [
Onshore,Offshore,unknown]Government assigned well number.
License number of the well.
Operator well number.
POSC well purpose
Allowable values: [
appraisal,appraisal -- confirmation appraisal,appraisal -- exploratory appraisal,exploration,exploration -- deeper-pool wildcat,exploration -- new-field wildcat,exploration -- new-pool wildcat,exploration -- outpost wildcat,exploration -- shallower-pool wildcat,development,development -- infill development,development -- injector,development -- producer,fluid storage,fluid storage -- gas storage,general srvc,general srvc -- borehole re-acquisition,general srvc -- observation,general srvc -- relief,general srvc -- research,general srvc -- research -- drill test,general srvc -- research -- strat test,general srvc -- waste disposal,mineral,unknown]POSC well status.
Allowable values: [
abandoned,active,active -- injecting,active -- producing,completed,drilling,partially plugged,permitted,plugged and abandoned,proposed,sold,suspended,temporarily abandoned,testing,tight,working over,unknown]Type of well.
Allowable values: [
bypass,initial,redrill,reentry,respud,sidetrack,unknown]
The unique identifier of the well
Well-known well kind specification
Default:
osdu:wks:well:0.0.1The geological interpretation's legal tags
- legal
The list of legal tags, see compliance API.
The list of other relevant data countries using the ISO 2-letter codes, see compliance API.
The legal status.
The version number of this well; set by the framework.
Get the Wellbore by using wks:wellbore:1.0.6 schema
Get the Wellbore object using its id.
If the wellbore kind is wks:wellbore:1.0.6 returns the record directly
If the wellbore kind is different wks:wellbore:1.0.6 it will get the raw record and convert the results to match the wks:wellbore:1.0.6. If convertion is not possible returns an error 500.
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
GET /ddms/v2/wellbores/{wellboreid}Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
Response
The base model forbids fields which are not declared initially in the pydantic model
The links to data, which constitute the inputs.
- ancestry
The meta data section linking the 'unitKey', 'crsKey' to self-contained definitions (persistableReference)
The reference entity type as declared in common:metadata:entity:*.
A generic dictionary of string keys mapping to string value. Only strings are permitted as keys and values.
Examples:{ "NameOfKey": "String value" }- tags
Timestamp of the time at which initial version of this OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:46:20.163ZThe user reference, which created the first version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comTimestamp of the time at which this version of the OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:52:24.477ZThe user reference, which created this version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comThe access control tags associated with this entity.
- acl
Wellbore data container
- data
The gap between water surface and offshore drilling platform.
- airGap
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The block name, in which the wellbore is located.
The country, in which the wellbore is located. The country name follows the convention in ISO 3166-1 'English short country name', see https://en.wikipedia.org/wiki/ISO_3166-1
The county name, in which the wellbore is located.
The UTC date time of the entity creation
The UTC date time of the last entity modification
Target days for drilling wellbore.
- drillingDaysTarget
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The wellbore's elevation reference from mean sea level (MSL), positive above MSL. This is where MD == 0 and TVD == 0
- elevationReference
The elevation above mean sea level (MSL), at which the vertical origin is 0.0. The 'unitKey' is further defined in 'frameOfReference.units'.
- elevationFromMsl
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The name of the Elevation Reference.
An array of identities (e.g. some kind if URL to be resolved in an external data store), which links to external realizations of the same entity.
The field name, to which the wellbore belongs.
The name of the formation at the wellbore's total depth.
The name of the formation at the wellbore's projected depth. This property is questionable as there is not precise documentation available.
True ("true" of "1") indicates that the wellbore has acheieved total depth. That is, drilling has completed. False ("false" or "0") indicates otherwise. Not given indicates that it is not known whether total depth has been reached.
True (="1" or "true") indicates that the wellbore is active. False (="0" or "false") indicates otherwise. It is the servers responsibility to set this value based on its available internal data (e.g., what objects are changing).
The kick-off point in measured depth (MD); for the main well the kickOffMd is set to 0.
- kickOffMd
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Kickoff true vertical depth of the wellbore; for the main wellbore the kickOffMd is set to 0.
- kickOffTvd
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
A 2D GeoJSON FeatureCollection defining wellbore location or trajectory in WGS 84 CRS.
- locationWGS84
The base model forbids fields which are not declared initially in the pydantic model
An enumeration.
Possible values: [
FeatureCollection]
The wellbore name
The operator of the wellbore.
The wellbore's permit date.
The wellbore's permit number or permit ID.
A location described by the Public Land Survey System (United States)
- plssLocation
Range, also known as Rng, R; a measure of the distance east or west from a referenced principal meridian, in units of six miles.
Section number (between 1 and 36)
Township, also known as T or Twp; (1) Synonym for survey township, i.e., a square parcel of land of 36 square miles, or (2) A measure of the distance north or south from a referenced baseline, in units of six miles
A terse, hierarchical reference to a piece of land, in which successive subdivisions of some larger area.
A dictionary structure, i.e. key/string value pairs, to carry additional wellbore properties.
The related entities.
- relationships
The definitive tome-depth relation providing the MD to seismic travel-time transformation.
- definitiveTimeDepthRelation
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
The definitive trajectory providing the MD to 3D space transformation.
- definitiveTrajectory
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
The tie-in wellbore if this wellbore is a side-track.
- tieInWellbore
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
The well to which this wellbore belongs.
- well
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
POSC wellbore trajectory shape.
Possible values: [
build and hold,deviated,double kickoff,horizontal,S-shaped,vertical,unknown]The date and time when activities to drill the borehole begin to create a hole in the earth. For a sidetrack, this is the date kickoff operations began. The format follows ISO 8601 YYYY-MM-DD extended format
The state name, in which the wellbore is located.
The measured depth of the borehole. If status is plugged, indicates the maximum depth reached before plugging. It is recommended that this value be updated about every 10 minutes by an assigned raw data provider at a site.
- totalDepthMd
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The total depth along the wellbore as reported by the drilling contractor from 'elevationReference'. The unit definition is found via the property's unitKey' in 'frameOfReference.units' dictionary..
- totalDepthMdDriller
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Planned measured depth for the wellbore total depth.
- totalDepthMdPlanned
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Planned measured for the wellbore total depth - with respect to seabed.
- totalDepthMdSubSeaPlanned
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The projected total measured depth of the borehole. This property is questionable as there is not precise documentation available.
- totalDepthProjectedMd
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The true vertical depth of the borehole. If status is plugged, indicates the maximum depth reached before plugging. It is recommended that this value be updated about every 10 minutes by an assigned raw data provider at a site.
- totalDepthTvd
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The total depth true vertical as reported by the drilling contractor from 'elevationReference', Downwards increasing. The unit definition is found via the property's unitKey' in 'frameOfReference.units' dictionary.
- totalDepthTvdDriller
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Planned true vertical depth for the wellbore total depth.
- totalDepthTvdPlanned
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Planned true vertical depth for the wellbore total depth - with respect to seabed.
- totalDepthTvdSubSeaPlanned
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The unique wellbore identifier, aka. API number, US well number or UBHI. Codes can have 10, 12 or 14 digits depending on the availability of directional sidetrack (2 digits) and event sequence codes (2 digits).
The wellbore's vertical position is an elevation from mean sea level (MSL), positive above MSL.
- wellHeadElevation
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The wellbore's well head position in the native, geographic CRS; vertical position is an elevation from mean sea level (MSL), positive above MSL.
- wellHeadGeographic
The 'crsKey', which can be looked up in the 'frameOfReference.crs' for further details.
Elevation from Mean Seal Level, downwards negative. The unit definition is found via 'elevationFromMsl.unitKey' in 'frameOfReference.units' dictionary.
- elevationFromMsl
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Native or original latitude (unit defined by CRS)
Native or original longitude (unit defined by CRS)
The wellbore's well head position in the native, projected CRS; vertical position is an elevation from mean sea level (MSL), positive above MSL.
- wellHeadProjected
The 'crsKey', which can be looked up in the 'frameOfReference.crs' for further details.
Elevation from Mean Seal Level, downwards negative. The unit definition is found via 'elevationFromMsl.unitKey' in 'frameOfReference.units' dictionary.
- elevationFromMsl
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
X-coordinate value in native or original projected CRS
Y-coordinate value in native or original projected CRS
The wellbore's position in WGS 84 latitude and longitude.
- wellHeadWgs84
The latitude value in degrees of arc (dega). Value range [-90, 90].
Possible values: -90 ≤ value ≤ 90
The longitude value in degrees of arc (dega). Value range [-180, 180]
Possible values: -180 ≤ value ≤ 180
Government assigned wellbore number.
Operator wellbore number.
POSC wellbore purpose
Possible values: [
appraisal,appraisal -- confirmation appraisal,appraisal -- exploratory appraisal,exploration,exploration -- deeper-pool wildcat,exploration -- new-field wildcat,exploration -- new-pool wildcat,exploration -- outpost wildcat,exploration -- shallower-pool wildcat,development,development -- infill development,development -- injector,development -- producer,fluid storage,fluid storage -- gas storage,general srvc,general srvc -- borehole re-acquisition,general srvc -- observation,general srvc -- relief,general srvc -- research,general srvc -- research -- drill test,general srvc -- research -- strat test,general srvc -- waste disposal,mineral,unknown]POSC wellbore status.
Possible values: [
abandoned,active,active -- injecting,active -- producing,completed,drilling,partially plugged,permitted,plugged and abandoned,proposed,sold,suspended,temporarily abandoned,testing,tight,working over,unknown]Type of wellbore.
Possible values: [
bypass,initial,redrill,reentry,respud,sidetrack,unknown]
The unique identifier of the wellbore
Well-known wellbore kind specification
The geological interpretation's legal tags
- legal
The list of legal tags, see compliance API.
The list of other relevant data countries using the ISO 2-letter codes, see compliance API.
The legal status.
The version number of this wellbore; set by the framework.
Status Code
Successful Response
Wellbore not found
Validation Error
No Sample Response
Delete the wellbore. The API performs a logical deletion of the given record
Required roles: 'users.datalake.editors' or 'users.datalake.admins'.
DELETE /ddms/v2/wellbores/{wellboreid}Get all versions of the Wellbore
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
GET /ddms/v2/wellbores/{wellboreid}/versions'Get the given version of the Wellbore by using wks:wellbore:1.0.6 schema
"Get the Wellbore object by using its id.
If the wellbore kind is wks:wellbore:1.0.6 returns the record directly
If the wellbore kind is different wks:wellbore:1.0.6 it will get the raw record and convert the results to match the wks:wellbore:1.0.6. If convertion is not possible returns an error 500.
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
GET /ddms/v2/wellbores/{wellboreid}/versions/{version}Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
Response
The base model forbids fields which are not declared initially in the pydantic model
The links to data, which constitute the inputs.
- ancestry
The meta data section linking the 'unitKey', 'crsKey' to self-contained definitions (persistableReference)
The reference entity type as declared in common:metadata:entity:*.
A generic dictionary of string keys mapping to string value. Only strings are permitted as keys and values.
Examples:{ "NameOfKey": "String value" }- tags
Timestamp of the time at which initial version of this OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:46:20.163ZThe user reference, which created the first version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comTimestamp of the time at which this version of the OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:52:24.477ZThe user reference, which created this version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comThe access control tags associated with this entity.
- acl
Wellbore data container
- data
The gap between water surface and offshore drilling platform.
- airGap
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The block name, in which the wellbore is located.
The country, in which the wellbore is located. The country name follows the convention in ISO 3166-1 'English short country name', see https://en.wikipedia.org/wiki/ISO_3166-1
The county name, in which the wellbore is located.
The UTC date time of the entity creation
The UTC date time of the last entity modification
Target days for drilling wellbore.
- drillingDaysTarget
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The wellbore's elevation reference from mean sea level (MSL), positive above MSL. This is where MD == 0 and TVD == 0
- elevationReference
The elevation above mean sea level (MSL), at which the vertical origin is 0.0. The 'unitKey' is further defined in 'frameOfReference.units'.
- elevationFromMsl
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The name of the Elevation Reference.
An array of identities (e.g. some kind if URL to be resolved in an external data store), which links to external realizations of the same entity.
The field name, to which the wellbore belongs.
The name of the formation at the wellbore's total depth.
The name of the formation at the wellbore's projected depth. This property is questionable as there is not precise documentation available.
True ("true" of "1") indicates that the wellbore has acheieved total depth. That is, drilling has completed. False ("false" or "0") indicates otherwise. Not given indicates that it is not known whether total depth has been reached.
True (="1" or "true") indicates that the wellbore is active. False (="0" or "false") indicates otherwise. It is the servers responsibility to set this value based on its available internal data (e.g., what objects are changing).
The kick-off point in measured depth (MD); for the main well the kickOffMd is set to 0.
- kickOffMd
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Kickoff true vertical depth of the wellbore; for the main wellbore the kickOffMd is set to 0.
- kickOffTvd
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
A 2D GeoJSON FeatureCollection defining wellbore location or trajectory in WGS 84 CRS.
- locationWGS84
The base model forbids fields which are not declared initially in the pydantic model
An enumeration.
Possible values: [
FeatureCollection]
The wellbore name
The operator of the wellbore.
The wellbore's permit date.
The wellbore's permit number or permit ID.
A location described by the Public Land Survey System (United States)
- plssLocation
Range, also known as Rng, R; a measure of the distance east or west from a referenced principal meridian, in units of six miles.
Section number (between 1 and 36)
Township, also known as T or Twp; (1) Synonym for survey township, i.e., a square parcel of land of 36 square miles, or (2) A measure of the distance north or south from a referenced baseline, in units of six miles
A terse, hierarchical reference to a piece of land, in which successive subdivisions of some larger area.
A dictionary structure, i.e. key/string value pairs, to carry additional wellbore properties.
The related entities.
- relationships
The definitive tome-depth relation providing the MD to seismic travel-time transformation.
- definitiveTimeDepthRelation
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
The definitive trajectory providing the MD to 3D space transformation.
- definitiveTrajectory
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
The tie-in wellbore if this wellbore is a side-track.
- tieInWellbore
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
The well to which this wellbore belongs.
- well
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
POSC wellbore trajectory shape.
Possible values: [
build and hold,deviated,double kickoff,horizontal,S-shaped,vertical,unknown]The date and time when activities to drill the borehole begin to create a hole in the earth. For a sidetrack, this is the date kickoff operations began. The format follows ISO 8601 YYYY-MM-DD extended format
The state name, in which the wellbore is located.
The measured depth of the borehole. If status is plugged, indicates the maximum depth reached before plugging. It is recommended that this value be updated about every 10 minutes by an assigned raw data provider at a site.
- totalDepthMd
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The total depth along the wellbore as reported by the drilling contractor from 'elevationReference'. The unit definition is found via the property's unitKey' in 'frameOfReference.units' dictionary..
- totalDepthMdDriller
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Planned measured depth for the wellbore total depth.
- totalDepthMdPlanned
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Planned measured for the wellbore total depth - with respect to seabed.
- totalDepthMdSubSeaPlanned
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The projected total measured depth of the borehole. This property is questionable as there is not precise documentation available.
- totalDepthProjectedMd
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The true vertical depth of the borehole. If status is plugged, indicates the maximum depth reached before plugging. It is recommended that this value be updated about every 10 minutes by an assigned raw data provider at a site.
- totalDepthTvd
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The total depth true vertical as reported by the drilling contractor from 'elevationReference', Downwards increasing. The unit definition is found via the property's unitKey' in 'frameOfReference.units' dictionary.
- totalDepthTvdDriller
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Planned true vertical depth for the wellbore total depth.
- totalDepthTvdPlanned
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Planned true vertical depth for the wellbore total depth - with respect to seabed.
- totalDepthTvdSubSeaPlanned
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The unique wellbore identifier, aka. API number, US well number or UBHI. Codes can have 10, 12 or 14 digits depending on the availability of directional sidetrack (2 digits) and event sequence codes (2 digits).
The wellbore's vertical position is an elevation from mean sea level (MSL), positive above MSL.
- wellHeadElevation
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The wellbore's well head position in the native, geographic CRS; vertical position is an elevation from mean sea level (MSL), positive above MSL.
- wellHeadGeographic
The 'crsKey', which can be looked up in the 'frameOfReference.crs' for further details.
Elevation from Mean Seal Level, downwards negative. The unit definition is found via 'elevationFromMsl.unitKey' in 'frameOfReference.units' dictionary.
- elevationFromMsl
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Native or original latitude (unit defined by CRS)
Native or original longitude (unit defined by CRS)
The wellbore's well head position in the native, projected CRS; vertical position is an elevation from mean sea level (MSL), positive above MSL.
- wellHeadProjected
The 'crsKey', which can be looked up in the 'frameOfReference.crs' for further details.
Elevation from Mean Seal Level, downwards negative. The unit definition is found via 'elevationFromMsl.unitKey' in 'frameOfReference.units' dictionary.
- elevationFromMsl
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
X-coordinate value in native or original projected CRS
Y-coordinate value in native or original projected CRS
The wellbore's position in WGS 84 latitude and longitude.
- wellHeadWgs84
The latitude value in degrees of arc (dega). Value range [-90, 90].
Possible values: -90 ≤ value ≤ 90
The longitude value in degrees of arc (dega). Value range [-180, 180]
Possible values: -180 ≤ value ≤ 180
Government assigned wellbore number.
Operator wellbore number.
POSC wellbore purpose
Possible values: [
appraisal,appraisal -- confirmation appraisal,appraisal -- exploratory appraisal,exploration,exploration -- deeper-pool wildcat,exploration -- new-field wildcat,exploration -- new-pool wildcat,exploration -- outpost wildcat,exploration -- shallower-pool wildcat,development,development -- infill development,development -- injector,development -- producer,fluid storage,fluid storage -- gas storage,general srvc,general srvc -- borehole re-acquisition,general srvc -- observation,general srvc -- relief,general srvc -- research,general srvc -- research -- drill test,general srvc -- research -- strat test,general srvc -- waste disposal,mineral,unknown]POSC wellbore status.
Possible values: [
abandoned,active,active -- injecting,active -- producing,completed,drilling,partially plugged,permitted,plugged and abandoned,proposed,sold,suspended,temporarily abandoned,testing,tight,working over,unknown]Type of wellbore.
Possible values: [
bypass,initial,redrill,reentry,respud,sidetrack,unknown]
The unique identifier of the wellbore
Well-known wellbore kind specification
The geological interpretation's legal tags
- legal
The list of legal tags, see compliance API.
The list of other relevant data countries using the ISO 2-letter codes, see compliance API.
The legal status.
The version number of this wellbore; set by the framework.
Status Code
Successful Response
Wellbore not found
Validation Error
No Sample Response
Create or update the Wellbores by using wks:wellbore:1.0.6 schema
Required roles: 'users.datalake.editors' or 'users.datalake.admins'.
POST /ddms/v2/wellbores
Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
The base model forbids fields which are not declared initially in the pydantic model
[
{
"acl": {
"viewers": [
"data.default.viewers@{{datapartitionid}}.{{domain}}.com"
],
"owners": [
"data.default.owners@{{datapartitionid}}.{{domain}}.com"
]
},
"data": {
"name": "myWellbore",
"airGap": {
"unitKey": "ft",
"value": 35
},
"country": "United States of America",
"dateCreated": "2013-03-22T11:16:03.123Z",
"dateModified": "2013-03-22T11:16:03.123Z",
"locationWGS84": {
"features": [
{
"geometry": {
"coordinates": [
[
-103.2380248,
46.8925081,
5301
],
[
-103.2380248,
46.8925081,
2801
],
[
-103.2378748,
46.892608100000004,
301
],
[
-103.23742477750001,
46.89270811,
-2199
],
[
-103.23667470999663,
46.892808120001,
-4699
],
[
-103.2356245974865,
46.892908130002,
-7199
]
],
"type": "LineString"
},
"properties": {
"name": "Newton 2-31-Lat-1"
},
"type": "Feature"
}
],
"type": "FeatureCollection"
},
"propertyDictionary": {
"Country Name": "UNITED STATES",
"Date First Report": "11-12-1982",
"Date Last Activity": "06-03-2016",
"Field Name": "WILDCAT",
"Well Num": "34-14"
},
"relationships": {
"well": {
"confidence": 1,
"id": "{datapartitionid}:well:myWell",
"name": "myWell"
}
},
"uwi": "33-089-00300-00-01",
"wellHeadGeographic": {
"crsKey": "geographic",
"elevationFromMsl": {
"unitKey": "ft",
"value": 2650.5
},
"latitude": 46.89249512931594,
"longitude": -103.23756979739804
},
"wellHeadProjected": {
"crsKey": "projected",
"elevationFromMsl": {
"unitKey": "ft",
"value": 2650.5
},
"x": 1315694.366039069,
"y": 458966.7531300551
},
"wellHeadWgs84": {
"latitude": 46.8925081,
"longitude": -103.2380248
},
"wellboreType": "bypass"
},
"meta": [
{
"kind": "Unit",
"name": "Measure depth default unit",
"persistableReference": "persistableReference",
"propertyNames": [
"symbol"
],
"propertyValues": [
"ft"
]
},
{
"kind": "CRS",
"name": "projected",
"persistableReference": "{\"lateBoundCRS\":{\"wkt\":\"PROJCS[\\\"NAD_1927_StatePlane_North_Dakota_South_FIPS_3302\\\",GEOGCS[\\\"GCS_North_American_1927\\\",DATUM[\\\"D_North_American_1927\\\",SPHEROID[\\\"Clarke_1866\\\",6378206.4,294.9786982]],PRIMEM[\\\"Greenwich\\\",0.0],UNIT[\\\"Degree\\\",0.0174532925199433]],PROJECTION[\\\"Lambert_Conformal_Conic\\\"],PARAMETER[\\\"False_Easting\\\",2000000.0],PARAMETER[\\\"False_Northing\\\",0.0],PARAMETER[\\\"Central_Meridian\\\",-100.5],PARAMETER[\\\"Standard_Parallel_1\\\",46.1833333333333],PARAMETER[\\\"Standard_Parallel_2\\\",47.4833333333333],PARAMETER[\\\"Latitude_Of_Origin\\\",45.6666666666667],UNIT[\\\"Foot_US\\\",0.304800609601219],AUTHORITY[\\\"EPSG\\\",32021]]\",\"ver\":\"PE_10_3_1\",\"name\":\"NAD_1927_StatePlane_North_Dakota_South_FIPS_3302\",\"authCode\":{\"auth\":\"EPSG\",\"code\":\"32021\"},\"type\":\"LBC\"},\"singleCT\":{\"wkt\":\"GEOGTRAN[\\\"NAD_1927_To_WGS_1984_79_CONUS\\\",GEOGCS[\\\"GCS_North_American_1927\\\",DATUM[\\\"D_North_American_1927\\\",SPHEROID[\\\"Clarke_1866\\\",6378206.4,294.9786982]],PRIMEM[\\\"Greenwich\\\",0.0],UNIT[\\\"Degree\\\",0.0174532925199433]],GEOGCS[\\\"GCS_WGS_1984\\\",DATUM[\\\"D_WGS_1984\\\",SPHEROID[\\\"WGS_1984\\\",6378137.0,298.257223563]],PRIMEM[\\\"Greenwich\\\",0.0],UNIT[\\\"Degree\\\",0.0174532925199433]],METHOD[\\\"NADCON\\\"],PARAMETER[\\\"Dataset_conus\\\",0.0],AUTHORITY[\\\"EPSG\\\",15851]]\",\"ver\":\"PE_10_3_1\",\"name\":\"NAD_1927_To_WGS_1984_79_CONUS\",\"authCode\":{\"auth\":\"EPSG\",\"code\":\"15851\"},\"type\":\"ST\"},\"ver\":\"PE_10_3_1\",\"name\":\"NAD27 * OGP-Usa Conus / North Dakota South [32021,15851]\",\"authCode\":{\"auth\":\"SLB\",\"code\":\"32021079\"},\"type\":\"EBC\"}",
"propertyNames": [
"wellHeadProjected.x",
"wellHeadProjected.y"
]
}
],
"id": "{{datapartitionid}}:wellbore:myWellbore",
"kind": "{{datapartitionid}}:wks:wellbore:1.0.6",
"legal": {
"legaltags": [
"{{legaltags}}"
],
"otherRelevantDataCountries": [
"FR",
"US"
],
"status": "compliant"
}
}
]The links to data, which constitute the inputs.
- ancestry
The meta data section linking the 'unitKey', 'crsKey' to self-contained definitions (persistableReference)
The reference entity type as declared in common:metadata:entity:*.
A generic dictionary of string keys mapping to string value. Only strings are permitted as keys and values.
Examples:{ "NameOfKey": "String value" }- tags
Timestamp of the time at which initial version of this OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:46:20.163ZThe user reference, which created the first version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comTimestamp of the time at which this version of the OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:52:24.477ZThe user reference, which created this version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comThe access control tags associated with this entity.
- acl
Wellbore data container
- data
The gap between water surface and offshore drilling platform.
- airGap
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The block name, in which the wellbore is located.
The country, in which the wellbore is located. The country name follows the convention in ISO 3166-1 'English short country name', see https://en.wikipedia.org/wiki/ISO_3166-1
The county name, in which the wellbore is located.
The UTC date time of the entity creation
The UTC date time of the last entity modification
Target days for drilling wellbore.
- drillingDaysTarget
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The wellbore's elevation reference from mean sea level (MSL), positive above MSL. This is where MD == 0 and TVD == 0
- elevationReference
The elevation above mean sea level (MSL), at which the vertical origin is 0.0. The 'unitKey' is further defined in 'frameOfReference.units'.
- elevationFromMsl
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The name of the Elevation Reference.
An array of identities (e.g. some kind if URL to be resolved in an external data store), which links to external realizations of the same entity.
The field name, to which the wellbore belongs.
The name of the formation at the wellbore's total depth.
The name of the formation at the wellbore's projected depth. This property is questionable as there is not precise documentation available.
True ("true" of "1") indicates that the wellbore has acheieved total depth. That is, drilling has completed. False ("false" or "0") indicates otherwise. Not given indicates that it is not known whether total depth has been reached.
Default:
trueTrue (="1" or "true") indicates that the wellbore is active. False (="0" or "false") indicates otherwise. It is the servers responsibility to set this value based on its available internal data (e.g., what objects are changing).
The kick-off point in measured depth (MD); for the main well the kickOffMd is set to 0.
- kickOffMd
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Kickoff true vertical depth of the wellbore; for the main wellbore the kickOffMd is set to 0.
- kickOffTvd
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
A 2D GeoJSON FeatureCollection defining wellbore location or trajectory in WGS 84 CRS.
- locationWGS84
The base model forbids fields which are not declared initially in the pydantic model
An enumeration.
Allowable values: [
FeatureCollection]
The wellbore name
The operator of the wellbore.
The wellbore's permit date.
The wellbore's permit number or permit ID.
A location described by the Public Land Survey System (United States)
- plssLocation
Range, also known as Rng, R; a measure of the distance east or west from a referenced principal meridian, in units of six miles.
Section number (between 1 and 36)
Township, also known as T or Twp; (1) Synonym for survey township, i.e., a square parcel of land of 36 square miles, or (2) A measure of the distance north or south from a referenced baseline, in units of six miles
A terse, hierarchical reference to a piece of land, in which successive subdivisions of some larger area.
A dictionary structure, i.e. key/string value pairs, to carry additional wellbore properties.
The related entities.
- relationships
The definitive tome-depth relation providing the MD to seismic travel-time transformation.
- definitiveTimeDepthRelation
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
The definitive trajectory providing the MD to 3D space transformation.
- definitiveTrajectory
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
The tie-in wellbore if this wellbore is a side-track.
- tieInWellbore
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
The well to which this wellbore belongs.
- well
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
POSC wellbore trajectory shape.
Allowable values: [
build and hold,deviated,double kickoff,horizontal,S-shaped,vertical,unknown]The date and time when activities to drill the borehole begin to create a hole in the earth. For a sidetrack, this is the date kickoff operations began. The format follows ISO 8601 YYYY-MM-DD extended format
The state name, in which the wellbore is located.
The measured depth of the borehole. If status is plugged, indicates the maximum depth reached before plugging. It is recommended that this value be updated about every 10 minutes by an assigned raw data provider at a site.
- totalDepthMd
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The total depth along the wellbore as reported by the drilling contractor from 'elevationReference'. The unit definition is found via the property's unitKey' in 'frameOfReference.units' dictionary..
- totalDepthMdDriller
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Planned measured depth for the wellbore total depth.
- totalDepthMdPlanned
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Planned measured for the wellbore total depth - with respect to seabed.
- totalDepthMdSubSeaPlanned
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The projected total measured depth of the borehole. This property is questionable as there is not precise documentation available.
- totalDepthProjectedMd
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The true vertical depth of the borehole. If status is plugged, indicates the maximum depth reached before plugging. It is recommended that this value be updated about every 10 minutes by an assigned raw data provider at a site.
- totalDepthTvd
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The total depth true vertical as reported by the drilling contractor from 'elevationReference', Downwards increasing. The unit definition is found via the property's unitKey' in 'frameOfReference.units' dictionary.
- totalDepthTvdDriller
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Planned true vertical depth for the wellbore total depth.
- totalDepthTvdPlanned
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Planned true vertical depth for the wellbore total depth - with respect to seabed.
- totalDepthTvdSubSeaPlanned
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The unique wellbore identifier, aka. API number, US well number or UBHI. Codes can have 10, 12 or 14 digits depending on the availability of directional sidetrack (2 digits) and event sequence codes (2 digits).
The wellbore's vertical position is an elevation from mean sea level (MSL), positive above MSL.
- wellHeadElevation
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The wellbore's well head position in the native, geographic CRS; vertical position is an elevation from mean sea level (MSL), positive above MSL.
- wellHeadGeographic
The 'crsKey', which can be looked up in the 'frameOfReference.crs' for further details.
Elevation from Mean Seal Level, downwards negative. The unit definition is found via 'elevationFromMsl.unitKey' in 'frameOfReference.units' dictionary.
- elevationFromMsl
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Native or original latitude (unit defined by CRS)
Native or original longitude (unit defined by CRS)
The wellbore's well head position in the native, projected CRS; vertical position is an elevation from mean sea level (MSL), positive above MSL.
- wellHeadProjected
The 'crsKey', which can be looked up in the 'frameOfReference.crs' for further details.
Elevation from Mean Seal Level, downwards negative. The unit definition is found via 'elevationFromMsl.unitKey' in 'frameOfReference.units' dictionary.
- elevationFromMsl
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
X-coordinate value in native or original projected CRS
Y-coordinate value in native or original projected CRS
The wellbore's position in WGS 84 latitude and longitude.
- wellHeadWgs84
The latitude value in degrees of arc (dega). Value range [-90, 90].
Possible values: -90 ≤ value ≤ 90
The longitude value in degrees of arc (dega). Value range [-180, 180]
Possible values: -180 ≤ value ≤ 180
Government assigned wellbore number.
Operator wellbore number.
POSC wellbore purpose
Allowable values: [
appraisal,appraisal -- confirmation appraisal,appraisal -- exploratory appraisal,exploration,exploration -- deeper-pool wildcat,exploration -- new-field wildcat,exploration -- new-pool wildcat,exploration -- outpost wildcat,exploration -- shallower-pool wildcat,development,development -- infill development,development -- injector,development -- producer,fluid storage,fluid storage -- gas storage,general srvc,general srvc -- borehole re-acquisition,general srvc -- observation,general srvc -- relief,general srvc -- research,general srvc -- research -- drill test,general srvc -- research -- strat test,general srvc -- waste disposal,mineral,unknown]POSC wellbore status.
Allowable values: [
abandoned,active,active -- injecting,active -- producing,completed,drilling,partially plugged,permitted,plugged and abandoned,proposed,sold,suspended,temporarily abandoned,testing,tight,working over,unknown]Type of wellbore.
Allowable values: [
bypass,initial,redrill,reentry,respud,sidetrack,unknown]
The unique identifier of the wellbore
Well-known wellbore kind specification
Default:
osdu:wks:wellbore:0.0.1The geological interpretation's legal tags
- legal
The list of legal tags, see compliance API.
The list of other relevant data countries using the ISO 2-letter codes, see compliance API.
The legal status.
The version number of this wellbore; set by the framework.
Get the LogSet by using wks:logSet:1.0.5 schema
Get the LogSet object using its id.
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
GET /ddms/v2/logsets/{logsetid}Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
Response
The base model forbids fields which are not declared initially in the pydantic model
The links to data, which constitute the inputs.
- ancestry
The meta data section linking the 'unitKey', 'crsKey' to self-contained definitions (persistableReference)
The reference entity type as declared in common:metadata:entity:*.
A generic dictionary of string keys mapping to string value. Only strings are permitted as keys and values.
Examples:{ "NameOfKey": "String value" }- tags
Timestamp of the time at which initial version of this OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:46:20.163ZThe user reference, which created the first version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comTimestamp of the time at which this version of the OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:52:24.477ZThe user reference, which created this version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comThe access control tags associated with this entity.
- acl
Log channel set associated with a wellbore
- data
Azimuth reference code defining the type of North. Only used for logSets with azimuth data
A list of channel Mnemonics in this log set.
A list of channel long names in this log set.
The well-known log set classification code.
The UTC date time of the entity creation
The UTC date time of the last entity modification
The base model forbids fields which are not declared initially in the pydantic model
An array of identities (e.g. some kind if URL to be resolved in an external data store), which links to external realizations of the same entity.
The name of this log set
The operation which created this entity
The base model forbids fields which are not declared initially in the pydantic model
The reference index type of the log set.
Used for data model allows extra fields which are not declared initially in the pydantic model
The base model forbids fields which are not declared initially in the pydantic model
The base model forbids fields which are not declared initially in the pydantic model
The base model forbids fields which are not declared initially in the pydantic model
The unique identifier of the log set
Kind specification
The log-set's legal tags
- legal
The list of legal tags, see compliance API.
The list of other relevant data countries using the ISO 2-letter codes, see compliance API.
The legal status.
The version number of this log set; set by the framework.
Status Code
Successful Response
LogSet not found
Validation Error
No Sample Response
Delete the LogSet. The API performs a logical deletion of the given record
Required roles: 'users.datalake.editors' or 'users.datalake.admins'.
DELETE /ddms/v2/logsets/{logsetid}Get all versions of the logset.
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
GET /ddms/v2/logsets/{logsetid}/versionsGet the given version of LogSet by using wks:logSet:1.0.5 schema
"Get the LogSet object using its id.
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
GET /ddms/v2/logsets/{logsetid}/versions/{version}Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
Response
The base model forbids fields which are not declared initially in the pydantic model
The links to data, which constitute the inputs.
- ancestry
The meta data section linking the 'unitKey', 'crsKey' to self-contained definitions (persistableReference)
The reference entity type as declared in common:metadata:entity:*.
A generic dictionary of string keys mapping to string value. Only strings are permitted as keys and values.
Examples:{ "NameOfKey": "String value" }- tags
Timestamp of the time at which initial version of this OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:46:20.163ZThe user reference, which created the first version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comTimestamp of the time at which this version of the OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:52:24.477ZThe user reference, which created this version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comThe access control tags associated with this entity.
- acl
Log channel set associated with a wellbore
- data
Azimuth reference code defining the type of North. Only used for logSets with azimuth data
A list of channel Mnemonics in this log set.
A list of channel long names in this log set.
The well-known log set classification code.
The UTC date time of the entity creation
The UTC date time of the last entity modification
The base model forbids fields which are not declared initially in the pydantic model
An array of identities (e.g. some kind if URL to be resolved in an external data store), which links to external realizations of the same entity.
The name of this log set
The operation which created this entity
The base model forbids fields which are not declared initially in the pydantic model
The reference index type of the log set.
Used for data model allows extra fields which are not declared initially in the pydantic model
The base model forbids fields which are not declared initially in the pydantic model
The base model forbids fields which are not declared initially in the pydantic model
The base model forbids fields which are not declared initially in the pydantic model
The unique identifier of the log set
Kind specification
The log-set's legal tags
- legal
The list of legal tags, see compliance API.
The list of other relevant data countries using the ISO 2-letter codes, see compliance API.
The legal status.
The version number of this log set; set by the framework.
Status Code
Successful Response
LogSet not found
Validation Error
No Sample Response
Create or update the LogSets by using wks:logSet:1.0.5 schema
Required roles: 'users.datalake.editors' or 'users.datalake.admins'.
POST /ddms/v2/logsets
Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
The base model forbids fields which are not declared initially in the pydantic model
[
{
"acl": {
"viewers": [
"data.default.viewers@{{datapartitionid}}.{{domain}}.com"
],
"owners": [
"data.default.owners@{{datapartitionid}}.{{domain}}.com"
]
},
"data": {
"name": "myLogset",
"channelMnemonics": [
"GR",
"NPOR",
"RHOB"
],
"channelNames": [
"Gamma Ray",
"Neutron Porosity",
"Bulk Density"
],
"relationships": {
"well": {
"confidence": 1,
"id": "{{datapartitionid}}:well:myWell",
"name": "myWell"
},
"wellbore": {
"confidence": 1,
"id": "{{datapartitionid}}:wellbore:myWellbore",
"name": "myWellbore"
}
},
"elevationReference": {
"elevationFromMsl": {
"unitKey": "ft",
"value": 2680.5
},
"name": "KB"
},
"reference": {
"dataType": "number",
"dimension": 1,
"family": "Measured Depth",
"familyType": "Depth",
"format": "float32",
"mnemonic": "MD",
"name": "Measured Depth",
"unitKey": "ft"
},
"referenceType": "Measured Depth"
},
"id": "{{datapartitionid}}:logSet:myLogset",
"kind": "{{datapartitionid}}:wks:logSet:1.0.5",
"legal": {
"legaltags": [
"{{legaltags}}"
],
"otherRelevantDataCountries": [
"FR",
"US"
],
"status": "compliant"
}
}
]The links to data, which constitute the inputs.
- ancestry
The meta data section linking the 'unitKey', 'crsKey' to self-contained definitions (persistableReference)
The reference entity type as declared in common:metadata:entity:*.
A generic dictionary of string keys mapping to string value. Only strings are permitted as keys and values.
Examples:{ "NameOfKey": "String value" }- tags
Timestamp of the time at which initial version of this OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:46:20.163ZThe user reference, which created the first version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comTimestamp of the time at which this version of the OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:52:24.477ZThe user reference, which created this version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comThe access control tags associated with this entity.
- acl
Log channel set associated with a wellbore
- data
Azimuth reference code defining the type of North. Only used for logSets with azimuth data
A list of channel Mnemonics in this log set.
A list of channel long names in this log set.
The well-known log set classification code.
Default:
Externally Processed LogSetThe UTC date time of the entity creation
The UTC date time of the last entity modification
The base model forbids fields which are not declared initially in the pydantic model
An array of identities (e.g. some kind if URL to be resolved in an external data store), which links to external realizations of the same entity.
The name of this log set
The operation which created this entity
The base model forbids fields which are not declared initially in the pydantic model
The reference index type of the log set.
Used for data model allows extra fields which are not declared initially in the pydantic model
The base model forbids fields which are not declared initially in the pydantic model
The base model forbids fields which are not declared initially in the pydantic model
The base model forbids fields which are not declared initially in the pydantic model
The unique identifier of the log set
Kind specification
Default:
osdu:wks:logSet:0.0.1The log-set's legal tags
- legal
The list of legal tags, see compliance API.
The list of other relevant data countries using the ISO 2-letter codes, see compliance API.
The legal status.
The version number of this log set; set by the framework.
Get the trajectory by using wks:trajectory:1.0.5 schema
Get the Trajectory object using its id.
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
GET /ddms/v2/trajectories/{trajectoryid}Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
Response
The base model forbids fields which are not declared initially in the pydantic model
The links to data, which constitute the inputs.
- ancestry
The meta data section linking the 'unitKey', 'crsKey' to self-contained definitions (persistableReference)
The reference entity type as declared in common:metadata:entity:*.
A generic dictionary of string keys mapping to string value. Only strings are permitted as keys and values.
Examples:{ "NameOfKey": "String value" }- tags
Timestamp of the time at which initial version of this OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:46:20.163ZThe user reference, which created the first version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comTimestamp of the time at which this version of the OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:52:24.477ZThe user reference, which created this version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comThe access control tags associated with this entity.
- acl
A log set representing a trajectory associated with a wellbore
- data
Azimuth reference code defining the type of North, default TN for true north.
A list of channel Mnemonics in this trajectory.
A list of channel long names in this trajectory.
The channels associated to the index.
The well-known trajectory classification code.
The UTC date time of the entity creation
The UTC date time of the last entity modification
The wellbore's elevation reference from mean sea level (MSL), positive above MSL. This is where MD == 0 and TVD == 0
- elevationReference
The elevation above mean sea level (MSL), at which the vertical origin is 0.0. The 'unitKey' is further defined in 'frameOfReference.units'.
- elevationFromMsl
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The name of the Elevation Reference.
An array of identities (e.g. some kind if URL to be resolved in an external data store), which links to external realizations of the same entity.
The index channel or log.
- index
Optional field carrying the absent value as string for this channel.
The azimuth reference of this log or channel. The detailed definition is found as persistable reference in the 'frameOfReference.azimuth' dictionary.
The CRS key of this log or channel. The detailed definition is found as persistable reference in the 'frameOfReference.crs' dictionary.
The log value type (per log sample). The 'format' property may contain further hints about data type presentation.
Possible values: [
string,number,integer,boolean]The dimension of this log or channel
The log family code of this log or channel (optional)
The log family type code of this log or channel. Example: 'Neutron Porosity' for 'Thermal Neutron Porosity Sandstone'. (optional)
Optional format hint how to treat the log values as strings or number of bits per 'dataType'.
Possible values: [
date,date-time,time,byte,binary,boolean,email,uuid,uri,int8,int16,int32,int64,float32,float64,float128]The id of this log or channel in the Logstore. This property is not present in the index channel.
bulkURI either URL or URN.
The long name of this log or channel
The mnemonic of this log or channel
The name of this log or channel.
The properties of this log or channel.
The source of this log or channel as a data reference; Typically this refers to the raw trajectory, from which this log WKE is generated.
The unit key of this log or channel. The detailed definition is found as persistable reference in the 'frameOfReference.units' dictionary. Empty units (NoUnit) are not recorded.
The index type of the trajectory.
The wellbore's trajectory preview shape as GeoJSON LineString.
- locationWGS84
The base model forbids fields which are not declared initially in the pydantic model
An enumeration.
Possible values: [
FeatureCollection]
The name of this trajectory
The 3D reference position for the first sample (surface location for main wellbores, tie-in point for side-tracks.
- referencePosition
3-dimensional point; the first coordinate is typically pointing east (easting or longitude), the second coordinate typically points north (northing or latitude). The third coordinate is an elevation (upwards positive, downwards negative). The point's CRS is given by the container.
The 'crsKey', which can be looked up in the 'frameOfReference.crs' for further details.
The 'unitKey' for the 3rd coordinate, which can be looked up in the 'frameOfReference.unit' for further details.
The related entities.
- relationships
The wellbore to which this trajectory belongs.
- wellbore
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
The start index value of the trajectory.
The index increment value of the trajectory.
The stop index value of the trajectory.
The wellbore's position in WGS 84 latitude and longitude; vertical position is an elevation from mean sea level (MSL), positive above MSL.
- wellHeadWgs84
Elevation from Mean Seal Level, downwards negative. The unit definition is found via 'elevationFromMsl.unitKey' in 'frameOfReference.units' dictionary.
- elevationFromMsl
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
WGS 84 latitude value in degrees (dega)
WGS 84 longitude value in degrees (dega)
The unique identifier of the trajectory
Kind specification
The trajectory's legal tags
- legal
The list of legal tags, see compliance API.
The list of other relevant data countries using the ISO 2-letter codes, see compliance API.
The legal status.
The version number of this trajectory; set by the framework.
Status Code
Successful Response
Trajectory not found
Validation Error
No Sample Response
Delete the Trajectory. The API performs a logical deletion of the given record
Required roles: 'users.datalake.editors' or 'users.datalake.admins'.
DELETE /ddms/v2/trajectories/{trajectoryid}Get all versions of the trajectory
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
GET /ddms/v2/trajectories/{trajectoryid}/versionsGet the given version of trajectory by using wks:Trajectory:1.0.5 schema
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
GET /ddms/v2/trajectories/{trajectoryid}/versions/{version}Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
Response
The base model forbids fields which are not declared initially in the pydantic model
The links to data, which constitute the inputs.
- ancestry
The meta data section linking the 'unitKey', 'crsKey' to self-contained definitions (persistableReference)
The reference entity type as declared in common:metadata:entity:*.
A generic dictionary of string keys mapping to string value. Only strings are permitted as keys and values.
Examples:{ "NameOfKey": "String value" }- tags
Timestamp of the time at which initial version of this OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:46:20.163ZThe user reference, which created the first version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comTimestamp of the time at which this version of the OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:52:24.477ZThe user reference, which created this version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comThe access control tags associated with this entity.
- acl
A log set representing a trajectory associated with a wellbore
- data
Azimuth reference code defining the type of North, default TN for true north.
A list of channel Mnemonics in this trajectory.
A list of channel long names in this trajectory.
The channels associated to the index.
The well-known trajectory classification code.
The UTC date time of the entity creation
The UTC date time of the last entity modification
The wellbore's elevation reference from mean sea level (MSL), positive above MSL. This is where MD == 0 and TVD == 0
- elevationReference
The elevation above mean sea level (MSL), at which the vertical origin is 0.0. The 'unitKey' is further defined in 'frameOfReference.units'.
- elevationFromMsl
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The name of the Elevation Reference.
An array of identities (e.g. some kind if URL to be resolved in an external data store), which links to external realizations of the same entity.
The index channel or log.
- index
Optional field carrying the absent value as string for this channel.
The azimuth reference of this log or channel. The detailed definition is found as persistable reference in the 'frameOfReference.azimuth' dictionary.
The CRS key of this log or channel. The detailed definition is found as persistable reference in the 'frameOfReference.crs' dictionary.
The log value type (per log sample). The 'format' property may contain further hints about data type presentation.
Possible values: [
string,number,integer,boolean]The dimension of this log or channel
The log family code of this log or channel (optional)
The log family type code of this log or channel. Example: 'Neutron Porosity' for 'Thermal Neutron Porosity Sandstone'. (optional)
Optional format hint how to treat the log values as strings or number of bits per 'dataType'.
Possible values: [
date,date-time,time,byte,binary,boolean,email,uuid,uri,int8,int16,int32,int64,float32,float64,float128]The id of this log or channel in the Logstore. This property is not present in the index channel.
bulkURI either URL or URN.
The long name of this log or channel
The mnemonic of this log or channel
The name of this log or channel.
The properties of this log or channel.
The source of this log or channel as a data reference; Typically this refers to the raw trajectory, from which this log WKE is generated.
The unit key of this log or channel. The detailed definition is found as persistable reference in the 'frameOfReference.units' dictionary. Empty units (NoUnit) are not recorded.
The index type of the trajectory.
The wellbore's trajectory preview shape as GeoJSON LineString.
- locationWGS84
The base model forbids fields which are not declared initially in the pydantic model
An enumeration.
Possible values: [
FeatureCollection]
The name of this trajectory
The 3D reference position for the first sample (surface location for main wellbores, tie-in point for side-tracks.
- referencePosition
3-dimensional point; the first coordinate is typically pointing east (easting or longitude), the second coordinate typically points north (northing or latitude). The third coordinate is an elevation (upwards positive, downwards negative). The point's CRS is given by the container.
The 'crsKey', which can be looked up in the 'frameOfReference.crs' for further details.
The 'unitKey' for the 3rd coordinate, which can be looked up in the 'frameOfReference.unit' for further details.
The related entities.
- relationships
The wellbore to which this trajectory belongs.
- wellbore
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
The start index value of the trajectory.
The index increment value of the trajectory.
The stop index value of the trajectory.
The wellbore's position in WGS 84 latitude and longitude; vertical position is an elevation from mean sea level (MSL), positive above MSL.
- wellHeadWgs84
Elevation from Mean Seal Level, downwards negative. The unit definition is found via 'elevationFromMsl.unitKey' in 'frameOfReference.units' dictionary.
- elevationFromMsl
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
WGS 84 latitude value in degrees (dega)
WGS 84 longitude value in degrees (dega)
The unique identifier of the trajectory
Kind specification
The trajectory's legal tags
- legal
The list of legal tags, see compliance API.
The list of other relevant data countries using the ISO 2-letter codes, see compliance API.
The legal status.
The version number of this trajectory; set by the framework.
Status Code
Successful Response
Trajectory not found
Validation Error
No Sample Response
Create or update the trajectories by using wks:Trajectory:1.0.5 schema
Required roles: 'users.datalake.editors' or 'users.datalake.admins'.
POST /ddms/v2/trajectories
Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
The base model forbids fields which are not declared initially in the pydantic model
[
{
"acl": {
"viewers": [
"data.default.viewers@{{datapartitionid}}.{{domain}}.com"
],
"owners": [
"data.default.owners@{{datapartitionid}}.{{domain}}.com"
]
},
"data": {
"azimuthReference": "string",
"channelMnemonics": [
"Measured Depth",
"True Vertical Depth",
"XOffset",
"YOffset"
],
"channelNames": [
"MD",
"TVD",
"X",
"Y"
],
"channels": [
{
"dimension": 1,
"family": "Measured Depth",
"name": "MD",
"unitKey": "ft"
},
{
"dimension": 1,
"family": "True Vertical Depth",
"name": "TVD",
"unitKey": "ft"
},
{
"dimension": 1,
"family": "XOffset",
"name": "X",
"unitKey": "ft"
},
{
"dimension": 1,
"family": "YOffset",
"name": "Y",
"unitKey": "ft"
}
],
"name": "myTrajectory",
"relationships": {
"well": {
"confidence": 1,
"id": "{{datapartitionid}}:well:myWell",
"name": "myWell"
},
"wellbore": {
"confidence": 1,
"id": "{{datapartitionid}}:wellbore:myWellbore",
"name": "myWellbore"
}
}
},
"id": "{{datapartitionid}}:trajectory:myTrajectory",
"kind": "{{datapartitionid}}:wks:trajectory:1.0.5",
"legal": {
"legaltags": [
"{{legaltags}}"
],
"otherRelevantDataCountries": [
"FR",
"US"
],
"status": "compliant"
}
}
]The links to data, which constitute the inputs.
- ancestry
The meta data section linking the 'unitKey', 'crsKey' to self-contained definitions (persistableReference)
The reference entity type as declared in common:metadata:entity:*.
A generic dictionary of string keys mapping to string value. Only strings are permitted as keys and values.
Examples:{ "NameOfKey": "String value" }- tags
Timestamp of the time at which initial version of this OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:46:20.163ZThe user reference, which created the first version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comTimestamp of the time at which this version of the OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:52:24.477ZThe user reference, which created this version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comThe access control tags associated with this entity.
- acl
A log set representing a trajectory associated with a wellbore
- data
Azimuth reference code defining the type of North, default TN for true north.
A list of channel Mnemonics in this trajectory.
A list of channel long names in this trajectory.
The channels associated to the index.
The well-known trajectory classification code.
Default:
Raw Deviation SurveyThe UTC date time of the entity creation
The UTC date time of the last entity modification
The wellbore's elevation reference from mean sea level (MSL), positive above MSL. This is where MD == 0 and TVD == 0
- elevationReference
The elevation above mean sea level (MSL), at which the vertical origin is 0.0. The 'unitKey' is further defined in 'frameOfReference.units'.
- elevationFromMsl
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The name of the Elevation Reference.
An array of identities (e.g. some kind if URL to be resolved in an external data store), which links to external realizations of the same entity.
The index channel or log.
- index
Optional field carrying the absent value as string for this channel.
The azimuth reference of this log or channel. The detailed definition is found as persistable reference in the 'frameOfReference.azimuth' dictionary.
The CRS key of this log or channel. The detailed definition is found as persistable reference in the 'frameOfReference.crs' dictionary.
The log value type (per log sample). The 'format' property may contain further hints about data type presentation.
Allowable values: [
string,number,integer,boolean]Default:
numberThe dimension of this log or channel
The log family code of this log or channel (optional)
The log family type code of this log or channel. Example: 'Neutron Porosity' for 'Thermal Neutron Porosity Sandstone'. (optional)
Optional format hint how to treat the log values as strings or number of bits per 'dataType'.
Allowable values: [
date,date-time,time,byte,binary,boolean,email,uuid,uri,int8,int16,int32,int64,float32,float64,float128]Default:
float32The id of this log or channel in the Logstore. This property is not present in the index channel.
bulkURI either URL or URN.
The long name of this log or channel
The mnemonic of this log or channel
The name of this log or channel.
The properties of this log or channel.
The source of this log or channel as a data reference; Typically this refers to the raw trajectory, from which this log WKE is generated.
The unit key of this log or channel. The detailed definition is found as persistable reference in the 'frameOfReference.units' dictionary. Empty units (NoUnit) are not recorded.
The index type of the trajectory.
The wellbore's trajectory preview shape as GeoJSON LineString.
- locationWGS84
The base model forbids fields which are not declared initially in the pydantic model
An enumeration.
Allowable values: [
FeatureCollection]
The name of this trajectory
The 3D reference position for the first sample (surface location for main wellbores, tie-in point for side-tracks.
- referencePosition
3-dimensional point; the first coordinate is typically pointing east (easting or longitude), the second coordinate typically points north (northing or latitude). The third coordinate is an elevation (upwards positive, downwards negative). The point's CRS is given by the container.
The 'crsKey', which can be looked up in the 'frameOfReference.crs' for further details.
The 'unitKey' for the 3rd coordinate, which can be looked up in the 'frameOfReference.unit' for further details.
The related entities.
- relationships
The wellbore to which this trajectory belongs.
- wellbore
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
The start index value of the trajectory.
The index increment value of the trajectory.
The stop index value of the trajectory.
The wellbore's position in WGS 84 latitude and longitude; vertical position is an elevation from mean sea level (MSL), positive above MSL.
- wellHeadWgs84
Elevation from Mean Seal Level, downwards negative. The unit definition is found via 'elevationFromMsl.unitKey' in 'frameOfReference.units' dictionary.
- elevationFromMsl
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
WGS 84 latitude value in degrees (dega)
WGS 84 longitude value in degrees (dega)
The unique identifier of the trajectory
Kind specification
Default:
osdu:wks:trajectory:0.0.1The trajectory's legal tags
- legal
The list of legal tags, see compliance API.
The list of other relevant data countries using the ISO 2-letter codes, see compliance API.
The legal status.
The version number of this trajectory; set by the framework.
Returns all data within the specified filters. Strongly consistent.
return full bulk data.
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
GET /ddms/v2/trajectories/{trajectoryid}/dataRequest
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
Query Parameters
List of channels to get. If not provided, return all channels.
define format when using JSON data is used. Value can be split, index, columns, records
Possible values: Value must match regular expression
split|index|columns|recordsDefault:
split
Response
- columns
- index
Status Code
Get trajectory data of the given channels. It uses Pandas.Dataframe json format. Here're examples for data with 5 rows for channels MD, TVD, X, Y with different orient:
- split:
{"columns":["MD","TVD","X","Y"],"index":[0,1,2,3,4],"data":[[0.0,0.0,1001,2001],[0.5,0.5,1002,2002],[1.0,0.75,1003,2003],[1.5,1.0,1004,2004],[2.0,1.5,1005,2005]]}
- index:
{"0":{"MD":0.0,"TVD":0.0,"X":1001,"Y":2001},"1":{"MD":0.5,"TVD":0.5,"X":1002,"Y":2002},"2":{"MD":1.0,"TVD":0.75,"X":1003,"Y":2003},"3":{"MD":1.5,"TVD":1.0,"X":1004,"Y":2004},"4":{"MD":2.0,"TVD":1.5,"X":1005,"Y":2005}}
- columns:
{"MD":{"0":0.0,"1":0.5,"2":1.0,"3":1.5,"4":2.0},"TVD":{"0":0.0,"1":0.5,"2":0.75,"3":1.0,"4":1.5},"X":{"0":1001,"1":1002,"2":1003,"3":1004,"4":1005},"Y":{"0":2001,"1":2002,"2":2003,"3":2004,"4":2005}}
- records:
[{"MD":0.0,"TVD":0.0,"X":1001,"Y":2001},{"MD":0.5,"TVD":0.5,"X":1002,"Y":2002},{"MD":1.0,"TVD":0.75,"X":1003,"Y":2003},{"MD":1.5,"TVD":1.0,"X":1004,"Y":2004},{"MD":2.0,"TVD":1.5,"X":1005,"Y":2005}]
- values:
[[0.0,0.0,1001,2001],[0.5,0.5,1002,2002],[1.0,0.75,1003,2003],[1.5,1.0,1004,2004],[2.0,1.5,1005,2005]]
- split:
No bulkURI
unknown channels
trajectory not found
Validation Error
Record has an invalid bulkURI
{"columns":["MD","TVD","X","Y"],"index":[0,1,2,3,4],"data":[[0.0,0.0,1001,2001],[0.5,0.5,1002,2002],[1.0,0.75,1003,2003],[1.5,1.0,1004,2004],[2.0,1.5,1005,2005]]}
Writes the specified data to the trajectory (atomic).
Overwrite if exists.
Required roles: 'users.datalake.editors' or 'users.datalake.admins'.
POST /ddms/v2/trajectories/{trajectoryid}/dataRequest
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
Query Parameters
define format when using JSON data is used. Value can be split, index, columns, records
Possible values: Value must match regular expression
split|index|columns|recordsDefault:
split
Write trajectory bulk data. Each column corresponds to a channel. It uses Pandas.Dataframe json format. Here're examples for data with 5 rows and 4 channels (MD, TVD, X, Y) with different orient:
- split:
{"columns":["MD","TVD","X","Y"],"index":[0,1,2,3,4],"data":[[0.0,0.0,1001,2001],[0.5,0.5,1002,2002],[1.0,0.75,1003,2003],[1.5,1.0,1004,2004],[2.0,1.5,1005,2005]]}
- index:
{"0":{"MD":0.0,"TVD":0.0,"X":1001,"Y":2001},"1":{"MD":0.5,"TVD":0.5,"X":1002,"Y":2002},"2":{"MD":1.0,"TVD":0.75,"X":1003,"Y":2003},"3":{"MD":1.5,"TVD":1.0,"X":1004,"Y":2004},"4":{"MD":2.0,"TVD":1.5,"X":1005,"Y":2005}}
- columns:
{"MD":{"0":0.0,"1":0.5,"2":1.0,"3":1.5,"4":2.0},"TVD":{"0":0.0,"1":0.5,"2":0.75,"3":1.0,"4":1.5},"X":{"0":1001,"1":1002,"2":1003,"3":1004,"4":1005},"Y":{"0":2001,"1":2002,"2":2003,"3":2004,"4":2005}}
- records:
[{"MD":0.0,"TVD":0.0,"X":1001,"Y":2001},{"MD":0.5,"TVD":0.5,"X":1002,"Y":2002},{"MD":1.0,"TVD":0.75,"X":1003,"Y":2003},{"MD":1.5,"TVD":1.0,"X":1004,"Y":2004},{"MD":2.0,"TVD":1.5,"X":1005,"Y":2005}]
Example: {"columns":["MD","TVD","X","Y"],"index":[0,1,2,3,4],"data":[[0.0,0.0,1001,2001],[0.5,0.5,1002,2002],[1.0,0.75,1003,2003],[1.5,1.0,1004,2004],[2.0,1.5,1005,2005]]}
- columns
- index
Get the marker by using wks:marker:1.0.4 schema
Get the Marker object using its id.
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
GET /ddms/v2/markers/{markerid}Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
Response
The base model forbids fields which are not declared initially in the pydantic model
The access control tags associated with this entity.
- acl
Marker kind specification
The marker's legal tags
- legal
The list of legal tags, see compliance API.
The list of other relevant data countries using the ISO 2-letter codes, see compliance API.
The legal status.
The links to data, which constitute the inputs.
- ancestry
The meta data section linking the 'unitKey', 'crsKey' to self-contained definitions (persistableReference)
The reference entity type as declared in common:metadata:entity:*.
A generic dictionary of string keys mapping to string value. Only strings are permitted as keys and values.
Examples:{ "NameOfKey": "String value" }- tags
Timestamp of the time at which initial version of this OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:46:20.163ZThe user reference, which created the first version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comTimestamp of the time at which this version of the OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:52:24.477ZThe user reference, which created this version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comGeological marker using a single point-observation, typically along a wellbore.
- data
The marker measured depth (MD) measured from data.elevationReference. The unit definition is found via the property's unitKey' in 'frameOfReference.units' dictionary.
- md
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The name of the marker
The absolute age at the feature boundary. The unit definition is found via the property's unitKey' in 'frameOfReference.units' dictionary.
- age
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The marker boundary relationship classification
The classification of the marker. Could be client-defined via a catalog, e.g. common:wke:markerClassification:1.0.0 and common:wke:markerClassificationMember:1.0.0
The UTC date time of the entity creation
The UTC date time of the last entity modification
The original marker depth - measured from data.elevationReference in data.depthReferenceType. The unit definition is found via the property's unitKey' in 'frameOfReference.units' dictionary.
- depth
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Depth reference code defining the type of depth for the marker. Default MD (measured depth). Depth is downwards increasing.
The elevation from mean sea level (MSL), where depth, topDepth, baseDepth are zero. Values above MSL are positive.
- elevationReference
The elevation above mean sea level (MSL), at which the vertical origin is 0.0. The 'unitKey' is further defined in 'frameOfReference.units'.
- elevationFromMsl
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The name of the Elevation Reference.
An array of identities (e.g. some kind if URL to be resolved in an external data store), which links to external realizations of the same entity.
The name of the interpreter who picked this marker.
The marker's shape as GeoJSON Point.
- locationWGS84
The base model forbids fields which are not declared initially in the pydantic model
An enumeration.
Possible values: [
FeatureCollection]
The marker's type of feature like 'seismic', 'structural', 'stratigraphic'
The marker's GeoScience domain like 'geologic', 'reservoir', 'petrophysical'
Further specification of the marker's sub-feature, e.g. in sequence stratigraphy.
The marker's sub-type of the feature like 'horizon', 'fault', 'fracture'
Azimuth angle. The azimuth reference is given by data.azimuthReference. The 'planeOrientationAzimuth.unitKey' is to be looked up in the 'frameOfReference.units' dictionary to find the self-contained definition.
- planeOrientationAzimuth
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Dip angle. The 'planeOrientationDip.unitKey' is to be looked up in the 'frameOfReference.units' dictionary to find the self-contained definition.
- planeOrientationDip
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The entities related to this marker.
- relationships
The related stratigraphic horizon
- horizon
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
The related stratigraphic table, which provides the context for the stratigraphic horizon
- stratigraphicTable
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
The study, in which this marker was conceived.
- study
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
The trajectory used to create the marker position
- trajectory
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
The wellbore entity, to which this marker belongs.
- wellbore
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
Optional hierarchical level in the chrono-stratigraphic/litho-stratigraphic catalog table, identified by the data.relationships.chartId
The marker true vertical depth (TVD) measured from data.elevationReference. The unit definition is found via the property's unitKey' in 'frameOfReference.units' dictionary.
- tvd
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Elevation from Mean Sea Level, downwards negative. The unit definition is found via the property's unitKey' in 'frameOfReference.units' dictionary.
- wgs84ElevationFromMsl
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The marker's position in WGS 84 latitude and longitude.
- wgs84LatitudeLongitude
The latitude value in degrees of arc (dega). Value range [-90, 90].
Possible values: -90 ≤ value ≤ 90
The longitude value in degrees of arc (dega). Value range [-180, 180]
Possible values: -180 ≤ value ≤ 180
The unique identifier of the marker
The version number of this marker; set by the framework.
Status Code
Successful Response
marker not found
Validation Error
No Sample Response
Delete the marker. The API performs a logical deletion of the given record
Required roles: 'users.datalake.editors' or 'users.datalake.admins'.
DELETE /ddms/v2/markers/{markerid}Get all versions of the marker
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
GET /ddms/v2/markers/{markerid}/versionsGet the given version of marker by using wks:marker:1.0.4 schema
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
GET /ddms/v2/markers/{markerid}/versions/{version}Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
Response
The base model forbids fields which are not declared initially in the pydantic model
The access control tags associated with this entity.
- acl
Marker kind specification
The marker's legal tags
- legal
The list of legal tags, see compliance API.
The list of other relevant data countries using the ISO 2-letter codes, see compliance API.
The legal status.
The links to data, which constitute the inputs.
- ancestry
The meta data section linking the 'unitKey', 'crsKey' to self-contained definitions (persistableReference)
The reference entity type as declared in common:metadata:entity:*.
A generic dictionary of string keys mapping to string value. Only strings are permitted as keys and values.
Examples:{ "NameOfKey": "String value" }- tags
Timestamp of the time at which initial version of this OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:46:20.163ZThe user reference, which created the first version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comTimestamp of the time at which this version of the OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:52:24.477ZThe user reference, which created this version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comGeological marker using a single point-observation, typically along a wellbore.
- data
The marker measured depth (MD) measured from data.elevationReference. The unit definition is found via the property's unitKey' in 'frameOfReference.units' dictionary.
- md
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The name of the marker
The absolute age at the feature boundary. The unit definition is found via the property's unitKey' in 'frameOfReference.units' dictionary.
- age
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The marker boundary relationship classification
The classification of the marker. Could be client-defined via a catalog, e.g. common:wke:markerClassification:1.0.0 and common:wke:markerClassificationMember:1.0.0
The UTC date time of the entity creation
The UTC date time of the last entity modification
The original marker depth - measured from data.elevationReference in data.depthReferenceType. The unit definition is found via the property's unitKey' in 'frameOfReference.units' dictionary.
- depth
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Depth reference code defining the type of depth for the marker. Default MD (measured depth). Depth is downwards increasing.
The elevation from mean sea level (MSL), where depth, topDepth, baseDepth are zero. Values above MSL are positive.
- elevationReference
The elevation above mean sea level (MSL), at which the vertical origin is 0.0. The 'unitKey' is further defined in 'frameOfReference.units'.
- elevationFromMsl
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The name of the Elevation Reference.
An array of identities (e.g. some kind if URL to be resolved in an external data store), which links to external realizations of the same entity.
The name of the interpreter who picked this marker.
The marker's shape as GeoJSON Point.
- locationWGS84
The base model forbids fields which are not declared initially in the pydantic model
An enumeration.
Possible values: [
FeatureCollection]
The marker's type of feature like 'seismic', 'structural', 'stratigraphic'
The marker's GeoScience domain like 'geologic', 'reservoir', 'petrophysical'
Further specification of the marker's sub-feature, e.g. in sequence stratigraphy.
The marker's sub-type of the feature like 'horizon', 'fault', 'fracture'
Azimuth angle. The azimuth reference is given by data.azimuthReference. The 'planeOrientationAzimuth.unitKey' is to be looked up in the 'frameOfReference.units' dictionary to find the self-contained definition.
- planeOrientationAzimuth
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Dip angle. The 'planeOrientationDip.unitKey' is to be looked up in the 'frameOfReference.units' dictionary to find the self-contained definition.
- planeOrientationDip
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The entities related to this marker.
- relationships
The related stratigraphic horizon
- horizon
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
The related stratigraphic table, which provides the context for the stratigraphic horizon
- stratigraphicTable
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
The study, in which this marker was conceived.
- study
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
The trajectory used to create the marker position
- trajectory
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
The wellbore entity, to which this marker belongs.
- wellbore
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
Optional hierarchical level in the chrono-stratigraphic/litho-stratigraphic catalog table, identified by the data.relationships.chartId
The marker true vertical depth (TVD) measured from data.elevationReference. The unit definition is found via the property's unitKey' in 'frameOfReference.units' dictionary.
- tvd
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Elevation from Mean Sea Level, downwards negative. The unit definition is found via the property's unitKey' in 'frameOfReference.units' dictionary.
- wgs84ElevationFromMsl
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The marker's position in WGS 84 latitude and longitude.
- wgs84LatitudeLongitude
The latitude value in degrees of arc (dega). Value range [-90, 90].
Possible values: -90 ≤ value ≤ 90
The longitude value in degrees of arc (dega). Value range [-180, 180]
Possible values: -180 ≤ value ≤ 180
The unique identifier of the marker
The version number of this marker; set by the framework.
Status Code
Successful Response
marker not found
Validation Error
No Sample Response
Create or update the markers by using wks:marker:1.0.4 schema
Required roles: 'users.datalake.editors' or 'users.datalake.admins'.
POST /ddms/v2/markers
Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
The base model forbids fields which are not declared initially in the pydantic model
[
{
"acl": {
"viewers": [
"data.default.viewers@{{datapartitionid}}.{{domain}}.com"
],
"owners": [
"data.default.owners@{{datapartitionid}}.{{domain}}.com"
]
},
"data": {
"depth": {
"unitKey": "ft",
"value": 150
},
"md": {
"unitKey": "ft",
"value": 150
},
"tvd": {
"unitKey": "ft",
"value": 200
},
"name": "myMarker",
"relationships": {
"well": {
"confidence": 1,
"id": "{{datapartitionid}}:well:myWell",
"name": "myWell"
},
"wellbore": {
"confidence": 1,
"id": "{{datapartitionid}}:wellbore:myWellbore",
"name": "myWellbore"
}
}
},
"id": "{{datapartitionid}}:marker:myMarker",
"kind": "{{datapartitionid}}:wks:marker:1.0.4",
"legal": {
"legaltags": [
"{{legaltags}}"
],
"otherRelevantDataCountries": [
"FR",
"US"
],
"status": "compliant"
}
}
]The access control tags associated with this entity.
- acl
Marker kind specification
The marker's legal tags
- legal
The list of legal tags, see compliance API.
The list of other relevant data countries using the ISO 2-letter codes, see compliance API.
The legal status.
The links to data, which constitute the inputs.
- ancestry
The meta data section linking the 'unitKey', 'crsKey' to self-contained definitions (persistableReference)
The reference entity type as declared in common:metadata:entity:*.
A generic dictionary of string keys mapping to string value. Only strings are permitted as keys and values.
Examples:{ "NameOfKey": "String value" }- tags
Timestamp of the time at which initial version of this OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:46:20.163ZThe user reference, which created the first version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comTimestamp of the time at which this version of the OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:52:24.477ZThe user reference, which created this version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comGeological marker using a single point-observation, typically along a wellbore.
- data
The marker measured depth (MD) measured from data.elevationReference. The unit definition is found via the property's unitKey' in 'frameOfReference.units' dictionary.
- md
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The name of the marker
The absolute age at the feature boundary. The unit definition is found via the property's unitKey' in 'frameOfReference.units' dictionary.
- age
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The marker boundary relationship classification
The classification of the marker. Could be client-defined via a catalog, e.g. common:wke:markerClassification:1.0.0 and common:wke:markerClassificationMember:1.0.0
The UTC date time of the entity creation
The UTC date time of the last entity modification
The original marker depth - measured from data.elevationReference in data.depthReferenceType. The unit definition is found via the property's unitKey' in 'frameOfReference.units' dictionary.
- depth
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Depth reference code defining the type of depth for the marker. Default MD (measured depth). Depth is downwards increasing.
Default:
MDThe elevation from mean sea level (MSL), where depth, topDepth, baseDepth are zero. Values above MSL are positive.
- elevationReference
The elevation above mean sea level (MSL), at which the vertical origin is 0.0. The 'unitKey' is further defined in 'frameOfReference.units'.
- elevationFromMsl
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The name of the Elevation Reference.
An array of identities (e.g. some kind if URL to be resolved in an external data store), which links to external realizations of the same entity.
The name of the interpreter who picked this marker.
The marker's shape as GeoJSON Point.
- locationWGS84
The base model forbids fields which are not declared initially in the pydantic model
An enumeration.
Allowable values: [
FeatureCollection]
The marker's type of feature like 'seismic', 'structural', 'stratigraphic'
The marker's GeoScience domain like 'geologic', 'reservoir', 'petrophysical'
Further specification of the marker's sub-feature, e.g. in sequence stratigraphy.
The marker's sub-type of the feature like 'horizon', 'fault', 'fracture'
Azimuth angle. The azimuth reference is given by data.azimuthReference. The 'planeOrientationAzimuth.unitKey' is to be looked up in the 'frameOfReference.units' dictionary to find the self-contained definition.
- planeOrientationAzimuth
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Dip angle. The 'planeOrientationDip.unitKey' is to be looked up in the 'frameOfReference.units' dictionary to find the self-contained definition.
- planeOrientationDip
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The entities related to this marker.
- relationships
The related stratigraphic horizon
- horizon
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
The related stratigraphic table, which provides the context for the stratigraphic horizon
- stratigraphicTable
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
The study, in which this marker was conceived.
- study
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
The trajectory used to create the marker position
- trajectory
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
The wellbore entity, to which this marker belongs.
- wellbore
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
Optional hierarchical level in the chrono-stratigraphic/litho-stratigraphic catalog table, identified by the data.relationships.chartId
The marker true vertical depth (TVD) measured from data.elevationReference. The unit definition is found via the property's unitKey' in 'frameOfReference.units' dictionary.
- tvd
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Elevation from Mean Sea Level, downwards negative. The unit definition is found via the property's unitKey' in 'frameOfReference.units' dictionary.
- wgs84ElevationFromMsl
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The marker's position in WGS 84 latitude and longitude.
- wgs84LatitudeLongitude
The latitude value in degrees of arc (dega). Value range [-90, 90].
Possible values: -90 ≤ value ≤ 90
The longitude value in degrees of arc (dega). Value range [-180, 180]
Possible values: -180 ≤ value ≤ 180
The unique identifier of the marker
The version number of this marker; set by the framework.
Get the Log using wks:log:1.0.5 schema
Get the log object using its data ecosystem id.
If the log kind is wks:log:1.0.5 returns the record directly
If the wellbore kind is different wks:log:1.0.5 it will get the raw record and convert the results to match the wks:log:1.0.5. If conversion is not possible returns an error 500.
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
GET /ddms/v2/logs/{logid}Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
Response
The base model forbids fields which are not declared initially in the pydantic model
The links to data, which constitute the inputs.
- ancestry
The meta data section linking the 'unitKey', 'crsKey' to self-contained definitions (persistableReference)
The reference entity type as declared in common:metadata:entity:*.
A generic dictionary of string keys mapping to string value. Only strings are permitted as keys and values.
Examples:{ "NameOfKey": "String value" }- tags
Timestamp of the time at which initial version of this OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:46:20.163ZThe user reference, which created the first version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comTimestamp of the time at which this version of the OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:52:24.477ZThe user reference, which created this version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comThe access control tags associated with this entity.
- acl
Log data associated with a wellbore
- data
Only supplied with azimuth logs: the azimuth reference code defining the type of North, default TN for true north.
The UTC date time of the entity creation
The UTC date time of the last entity modification
The wellbore's elevation reference from mean sea level (MSL), positive above MSL. This is where the index, e.g. MD == 0 and TVD == 0.
- elevationReference
The elevation above mean sea level (MSL), at which the vertical origin is 0.0. The 'unitKey' is further defined in 'frameOfReference.units'.
- elevationFromMsl
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The name of the Elevation Reference.
An array of identities (e.g. some kind if URL to be resolved in an external data store), which links to external realizations of the same entity.
An array of historyRecords describing the context for the log's creation or processing.
The log containing the log meta data and log-store reference.
- log
A list of names for multi-dimensional logs (dimension>1). The length of this array is expected to be equal to 'dimension'. For one-dimensional this property stays empty as the columnName is by definition the log name.
The log value type (per log sample). The 'format' property may contain further hints about data type presentation.
Possible values: [
string,number,integer,boolean,date-time]The dimension of this log or channel
The log family code of this log or channel (optional)
The log family type code of this log or channel. Example: 'Neutron Porosity' for 'Thermal Neutron Porosity Sandstone'. (optional)
Optional format hint how to treat the log values as strings or number of bits per 'dataType'.
Possible values: [
date,date-time,time,byte,binary,email,uuid,uri,int8,int16,int32,int64,float32,float64,float128]The unique id of this log or channel in the Logstore. This property is not present in the index channel.
bulkURI either URL or URN.
The long name of this log or channel
The mnemonic of this log or channel
The name of this log or channel.
The named properties of this log or channel.
The source of this log or channel as a data reference; Typically this refers to the raw LogSet, from which this log WKE is generated.
The unitKey to be looked up in the 'frameOfReference.units' dictionary to find the self-contained definition.
The name of this log set
The operation which created this Log
The reference index - only populated for logs, which are member of a logSet and share the reference index.
- reference
A list of names for multi-dimensional logs (dimension>1). The length of this array is expected to be equal to 'dimension'. For one-dimensional this property stays empty as the columnName is by definition the log name.
The log value type (per log sample). The 'format' property may contain further hints about data type presentation.
Possible values: [
string,number,integer,boolean,date-time]The dimension of this log or channel
The log family code of this log or channel (optional)
The log family type code of this log or channel. Example: 'Neutron Porosity' for 'Thermal Neutron Porosity Sandstone'. (optional)
Optional format hint how to treat the log values as strings or number of bits per 'dataType'.
Possible values: [
date,date-time,time,byte,binary,email,uuid,uri,int8,int16,int32,int64,float32,float64,float128]The unique id of this log or channel in the Logstore. This property is not present in the index channel.
bulkURI either URL or URN.
The long name of this log or channel
The mnemonic of this log or channel
The name of this log or channel.
The named properties of this log or channel.
The source of this log or channel as a data reference; Typically this refers to the raw LogSet, from which this log WKE is generated.
The unitKey to be looked up in the 'frameOfReference.units' dictionary to find the self-contained definition.
The reference index type of the log set.
Possible values: [
Date,Date Time,Measured Depth,Core depth,True Vertical Depth,True Vertical Depth Sub Sea,One-Way Time,Two-Way Time]The related entities.
- relationships
The logSet to which this log belongs. If the log is not part of a log set this relationship stays empty.
- logSet
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
The timeDepthRelation to which this log belongs. If the log is not part of a timeDepthRelation this relationship stays empty.
- timeDepthRelation
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
The well to which this log belongs. Only required if the wellbore is unknown.
- well
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
The wellbore to which this log belongs. This relationship is the most important; only the wellbore can provide the unique context for the measured depth index.
- wellbore
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
The start index value of the log set.
- start
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The index increment value of the log set. Only populated if the log is regularly sampled.
- step
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The stop index value of the log set.
- stop
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The unique identifier of the log
Kind specification
The log's legal tags
- legal
The list of legal tags, see compliance API.
The list of other relevant data countries using the ISO 2-letter codes, see compliance API.
The legal status.
The status of this log
The version number of this log; set by the framework.
Status Code
Successful Response
log not found
Validation Error
No Sample Response
Delete the log. The API performs a logical deletion of the given record
Required roles: 'users.datalake.editors' or 'users.datalake.admins'.
DELETE /ddms/v2/logs/{logid}Create or update the logs by using wks:log:1.0.5 schema
Required roles: 'users.datalake.editors' or 'users.datalake.admins'.
POST /ddms/v2/logs
Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
The base model forbids fields which are not declared initially in the pydantic model
[
{
"acl": {
"viewers": [
"data.default.viewers@{{datapartitionid}}.{{domain}}.com"
],
"owners": [
"data.default.owners@{{datapartitionid}}.{{domain}}.com"
]
},
"data": {
"name": "myLog_GR",
"history": [
{
"date": "2019-02-01T11:16:03Z",
"description": "Fake example",
"user": "BWillis"
}
],
"log": {
"dataType": "number",
"dimension": 1,
"family": "Gamma Ray",
"familyType": "Gamma Ray",
"format": "float32",
"mnemonic": "GR",
"name": "myLog_GR",
"properties": [
{
"description": "Linear depth offset of the channel sensor relative to some reference point, typically the toolstring zero",
"name": "MEASURE_POINT_OFFSET",
"unitKey": "m",
"value": 0.264922
}
],
"unitKey": "gAPI"
},
"reference": {
"dataType": "number",
"dimension": 1,
"family": "Measured Depth",
"familyType": "Depth",
"format": "float32",
"mnemonic": "MD",
"name": "Measured Depth",
"unitKey": "ft"
},
"referenceType": "Measured Depth",
"relationships": {
"logSet": {
"confidence": 1,
"id": "{{datapartitionid}}:logSet:myLogset",
"name": "myLogset"
},
"well": {
"confidence": 1,
"id": "{{datapartitionid}}:well:myWell",
"name": "myWell"
},
"wellbore": {
"confidence": 1,
"id": "{{datapartitionid}}:wellbore:myWellbore",
"name": "myWellbore"
}
}
},
"id": "{{datapartitionid}}:log:myLog_GR",
"kind": "{{datapartitionid}}:wks:log:1.0.5",
"legal": {
"legaltags": [
"{{legaltags}}"
],
"otherRelevantDataCountries": [
"FR",
"US"
],
"status": "compliant"
}
}
]The links to data, which constitute the inputs.
- ancestry
The meta data section linking the 'unitKey', 'crsKey' to self-contained definitions (persistableReference)
The reference entity type as declared in common:metadata:entity:*.
A generic dictionary of string keys mapping to string value. Only strings are permitted as keys and values.
Examples:{ "NameOfKey": "String value" }- tags
Timestamp of the time at which initial version of this OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:46:20.163ZThe user reference, which created the first version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comTimestamp of the time at which this version of the OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:52:24.477ZThe user reference, which created this version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comThe access control tags associated with this entity.
- acl
Log data associated with a wellbore
- data
Only supplied with azimuth logs: the azimuth reference code defining the type of North, default TN for true north.
The UTC date time of the entity creation
The UTC date time of the last entity modification
The wellbore's elevation reference from mean sea level (MSL), positive above MSL. This is where the index, e.g. MD == 0 and TVD == 0.
- elevationReference
The elevation above mean sea level (MSL), at which the vertical origin is 0.0. The 'unitKey' is further defined in 'frameOfReference.units'.
- elevationFromMsl
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The name of the Elevation Reference.
An array of identities (e.g. some kind if URL to be resolved in an external data store), which links to external realizations of the same entity.
An array of historyRecords describing the context for the log's creation or processing.
The log containing the log meta data and log-store reference.
- log
A list of names for multi-dimensional logs (dimension>1). The length of this array is expected to be equal to 'dimension'. For one-dimensional this property stays empty as the columnName is by definition the log name.
The log value type (per log sample). The 'format' property may contain further hints about data type presentation.
Allowable values: [
string,number,integer,boolean,date-time]Default:
numberThe dimension of this log or channel
The log family code of this log or channel (optional)
The log family type code of this log or channel. Example: 'Neutron Porosity' for 'Thermal Neutron Porosity Sandstone'. (optional)
Optional format hint how to treat the log values as strings or number of bits per 'dataType'.
Allowable values: [
date,date-time,time,byte,binary,email,uuid,uri,int8,int16,int32,int64,float32,float64,float128]Default:
float32The unique id of this log or channel in the Logstore. This property is not present in the index channel.
bulkURI either URL or URN.
The long name of this log or channel
The mnemonic of this log or channel
The name of this log or channel.
The named properties of this log or channel.
The source of this log or channel as a data reference; Typically this refers to the raw LogSet, from which this log WKE is generated.
The unitKey to be looked up in the 'frameOfReference.units' dictionary to find the self-contained definition.
The name of this log set
The operation which created this Log
The reference index - only populated for logs, which are member of a logSet and share the reference index.
- reference
A list of names for multi-dimensional logs (dimension>1). The length of this array is expected to be equal to 'dimension'. For one-dimensional this property stays empty as the columnName is by definition the log name.
The log value type (per log sample). The 'format' property may contain further hints about data type presentation.
Allowable values: [
string,number,integer,boolean,date-time]Default:
numberThe dimension of this log or channel
The log family code of this log or channel (optional)
The log family type code of this log or channel. Example: 'Neutron Porosity' for 'Thermal Neutron Porosity Sandstone'. (optional)
Optional format hint how to treat the log values as strings or number of bits per 'dataType'.
Allowable values: [
date,date-time,time,byte,binary,email,uuid,uri,int8,int16,int32,int64,float32,float64,float128]Default:
float32The unique id of this log or channel in the Logstore. This property is not present in the index channel.
bulkURI either URL or URN.
The long name of this log or channel
The mnemonic of this log or channel
The name of this log or channel.
The named properties of this log or channel.
The source of this log or channel as a data reference; Typically this refers to the raw LogSet, from which this log WKE is generated.
The unitKey to be looked up in the 'frameOfReference.units' dictionary to find the self-contained definition.
The reference index type of the log set.
Allowable values: [
Date,Date Time,Measured Depth,Core depth,True Vertical Depth,True Vertical Depth Sub Sea,One-Way Time,Two-Way Time]The related entities.
- relationships
The logSet to which this log belongs. If the log is not part of a log set this relationship stays empty.
- logSet
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
The timeDepthRelation to which this log belongs. If the log is not part of a timeDepthRelation this relationship stays empty.
- timeDepthRelation
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
The well to which this log belongs. Only required if the wellbore is unknown.
- well
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
The wellbore to which this log belongs. This relationship is the most important; only the wellbore can provide the unique context for the measured depth index.
- wellbore
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
The start index value of the log set.
- start
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The index increment value of the log set. Only populated if the log is regularly sampled.
- step
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The stop index value of the log set.
- stop
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The unique identifier of the log
Kind specification
Default:
osdu:wks:log:0.0.1The log's legal tags
- legal
The list of legal tags, see compliance API.
The list of other relevant data countries using the ISO 2-letter codes, see compliance API.
The legal status.
The status of this log
Default:
compliantThe version number of this log; set by the framework.
Get all versions of the log
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
GET /ddms/v2/logs/{logid}/versionsGet the given version of log by using wks:log:1.0.5 schema
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
GET /ddms/v2/logs/{logid}/versions/{version}Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
Response
The base model forbids fields which are not declared initially in the pydantic model
The links to data, which constitute the inputs.
- ancestry
The meta data section linking the 'unitKey', 'crsKey' to self-contained definitions (persistableReference)
The reference entity type as declared in common:metadata:entity:*.
A generic dictionary of string keys mapping to string value. Only strings are permitted as keys and values.
Examples:{ "NameOfKey": "String value" }- tags
Timestamp of the time at which initial version of this OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:46:20.163ZThe user reference, which created the first version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comTimestamp of the time at which this version of the OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:52:24.477ZThe user reference, which created this version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comThe access control tags associated with this entity.
- acl
Log data associated with a wellbore
- data
Only supplied with azimuth logs: the azimuth reference code defining the type of North, default TN for true north.
The UTC date time of the entity creation
The UTC date time of the last entity modification
The wellbore's elevation reference from mean sea level (MSL), positive above MSL. This is where the index, e.g. MD == 0 and TVD == 0.
- elevationReference
The elevation above mean sea level (MSL), at which the vertical origin is 0.0. The 'unitKey' is further defined in 'frameOfReference.units'.
- elevationFromMsl
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The name of the Elevation Reference.
An array of identities (e.g. some kind if URL to be resolved in an external data store), which links to external realizations of the same entity.
An array of historyRecords describing the context for the log's creation or processing.
The log containing the log meta data and log-store reference.
- log
A list of names for multi-dimensional logs (dimension>1). The length of this array is expected to be equal to 'dimension'. For one-dimensional this property stays empty as the columnName is by definition the log name.
The log value type (per log sample). The 'format' property may contain further hints about data type presentation.
Possible values: [
string,number,integer,boolean,date-time]The dimension of this log or channel
The log family code of this log or channel (optional)
The log family type code of this log or channel. Example: 'Neutron Porosity' for 'Thermal Neutron Porosity Sandstone'. (optional)
Optional format hint how to treat the log values as strings or number of bits per 'dataType'.
Possible values: [
date,date-time,time,byte,binary,email,uuid,uri,int8,int16,int32,int64,float32,float64,float128]The unique id of this log or channel in the Logstore. This property is not present in the index channel.
bulkURI either URL or URN.
The long name of this log or channel
The mnemonic of this log or channel
The name of this log or channel.
The named properties of this log or channel.
The source of this log or channel as a data reference; Typically this refers to the raw LogSet, from which this log WKE is generated.
The unitKey to be looked up in the 'frameOfReference.units' dictionary to find the self-contained definition.
The name of this log set
The operation which created this Log
The reference index - only populated for logs, which are member of a logSet and share the reference index.
- reference
A list of names for multi-dimensional logs (dimension>1). The length of this array is expected to be equal to 'dimension'. For one-dimensional this property stays empty as the columnName is by definition the log name.
The log value type (per log sample). The 'format' property may contain further hints about data type presentation.
Possible values: [
string,number,integer,boolean,date-time]The dimension of this log or channel
The log family code of this log or channel (optional)
The log family type code of this log or channel. Example: 'Neutron Porosity' for 'Thermal Neutron Porosity Sandstone'. (optional)
Optional format hint how to treat the log values as strings or number of bits per 'dataType'.
Possible values: [
date,date-time,time,byte,binary,email,uuid,uri,int8,int16,int32,int64,float32,float64,float128]The unique id of this log or channel in the Logstore. This property is not present in the index channel.
bulkURI either URL or URN.
The long name of this log or channel
The mnemonic of this log or channel
The name of this log or channel.
The named properties of this log or channel.
The source of this log or channel as a data reference; Typically this refers to the raw LogSet, from which this log WKE is generated.
The unitKey to be looked up in the 'frameOfReference.units' dictionary to find the self-contained definition.
The reference index type of the log set.
Possible values: [
Date,Date Time,Measured Depth,Core depth,True Vertical Depth,True Vertical Depth Sub Sea,One-Way Time,Two-Way Time]The related entities.
- relationships
The logSet to which this log belongs. If the log is not part of a log set this relationship stays empty.
- logSet
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
The timeDepthRelation to which this log belongs. If the log is not part of a timeDepthRelation this relationship stays empty.
- timeDepthRelation
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
The well to which this log belongs. Only required if the wellbore is unknown.
- well
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
The wellbore to which this log belongs. This relationship is the most important; only the wellbore can provide the unique context for the measured depth index.
- wellbore
The confidence of the relationship. If the property is absent a well-known relation is implied.
The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.
The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.
The version number of the related entity. If no version number is specified, the last version is implied.
The start index value of the log set.
- start
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The index increment value of the log set. Only populated if the log is regularly sampled.
- step
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The stop index value of the log set.
- stop
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
The unique identifier of the log
Kind specification
The log's legal tags
- legal
The list of legal tags, see compliance API.
The list of other relevant data countries using the ISO 2-letter codes, see compliance API.
The legal status.
The status of this log
The version number of this log; set by the framework.
Status Code
Successful Response
log not found
Validation Error
No Sample Response
Returns all data within the specified filters. Strongly consistent.
return full bulk data.
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
GET /ddms/v2/logs/{logid}/dataRequest
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
Query Parameters
define format when using JSON data is used. Value can be split, index, columns, records, values
Possible values: Value must match regular expression
split|index|columns|records|valuesDefault:
splitThe json path to the bulk reference (see https://goessner.net/articles/JsonPath/). Required for non wks:log.
Response
- columns
- index
Status Code
Get log bulk data in format in the given orient value. It uses Pandas.Dataframe json format. Here're examples for data with 5 rows and 3 columns with different orient:
- split:
{"columns":["Ref","col_100X","col_200X"],"index":[0,1,2,3,4],"data":[[0.0,1001,2001],[0.5,1002,2002],[1.0,1003,2003],[1.5,1004,2004],[2.0,1005,2005]]}
- index:
{"0":{"Ref":0.0,"col_100X":1001,"col_200X":2001},"1":{"Ref":0.5,"col_100X":1002,"col_200X":2002},"2":{"Ref":1.0,"col_100X":1003,"col_200X":2003},"3":{"Ref":1.5,"col_100X":1004,"col_200X":2004},"4":{"Ref":2.0,"col_100X":1005,"col_200X":2005}}
- columns:
{"Ref":{"0":0.0,"1":0.5,"2":1.0,"3":1.5,"4":2.0},"col_100X":{"0":1001,"1":1002,"2":1003,"3":1004,"4":1005},"col_200X":{"0":2001,"1":2002,"2":2003,"3":2004,"4":2005}}
- records:
[{"Ref":0.0,"col_100X":1001,"col_200X":2001},{"Ref":0.5,"col_100X":1002,"col_200X":2002},{"Ref":1.0,"col_100X":1003,"col_200X":2003},{"Ref":1.5,"col_100X":1004,"col_200X":2004},{"Ref":2.0,"col_100X":1005,"col_200X":2005}]
- values:
[[0.0,1001,2001],[0.5,1002,2002],[1.0,1003,2003],[1.5,1004,2004],[2.0,1005,2005]]
- split:
log not found
Validation Error
{"columns":["Ref","col_100X","col_200X"],"index":[0,1,2,3,4],"data":[[0.0,1001,2001],[0.5,1002,2002],[1.0,1003,2003],[1.5,1004,2004],[2.0,1005,2005]]}
Writes the specified data to the log (atomic).
Overwrite if exists.
Required roles: 'users.datalake.editors' or 'users.datalake.admins'.
POST /ddms/v2/logs/{logid}/dataRequest
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
Query Parameters
define format when using JSON data is used. Value can be split, index, columns, records, values
Possible values: Value must match regular expression
split|index|columns|records|valuesDefault:
splitThe json path to the bulk reference (see https://goessner.net/articles/JsonPath/). Required for non wks:log.
Write log bulk data. It uses Pandas.Dataframe json format. Here're examples for data with 5 rows and 3 columns with different orient:
- split:
{"columns":["Ref","col_100X","col_200X"],"index":[0,1,2,3,4],"data":[[0.0,1001,2001],[0.5,1002,2002],[1.0,1003,2003],[1.5,1004,2004],[2.0,1005,2005]]}
- index:
{"0":{"Ref":0.0,"col_100X":1001,"col_200X":2001},"1":{"Ref":0.5,"col_100X":1002,"col_200X":2002},"2":{"Ref":1.0,"col_100X":1003,"col_200X":2003},"3":{"Ref":1.5,"col_100X":1004,"col_200X":2004},"4":{"Ref":2.0,"col_100X":1005,"col_200X":2005}}
- columns:
{"Ref":{"0":0.0,"1":0.5,"2":1.0,"3":1.5,"4":2.0},"col_100X":{"0":1001,"1":1002,"2":1003,"3":1004,"4":1005},"col_200X":{"0":2001,"1":2002,"2":2003,"3":2004,"4":2005}}
- records:
[{"Ref":0.0,"col_100X":1001,"col_200X":2001},{"Ref":0.5,"col_100X":1002,"col_200X":2002},{"Ref":1.0,"col_100X":1003,"col_200X":2003},{"Ref":1.5,"col_100X":1004,"col_200X":2004},{"Ref":2.0,"col_100X":1005,"col_200X":2005}]
- values:
[[0.0,1001,2001],[0.5,1002,2002],[1.0,1003,2003],[1.5,1004,2004],[2.0,1005,2005]]
- columns
- index
Writes the data to the log. Support json file (then orient must be provided) and parquet
Overwrite if exists.
Required roles: 'users.datalake.editors' or 'users.datalake.admins'.
POST /ddms/v2/logs/{logid}/upload_dataRequest
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
Query Parameters
define format when using JSON data is used. Value can be split, index, columns, records, values
Possible values: Value must match regular expression
split|index|columns|records|valuesDefault:
splitThe json path to the bulk reference (see https://goessner.net/articles/JsonPath/). Required for non wks:log.
Form Parameters
Data statistics
This API will return count, mean, std, min, max and percentiles of each column.
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
GET /ddms/v2/logs/{logid}/statisticsReturns all data within the specified filters. Strongly consistent.
return full bulk data.
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
GET /ddms/v2/logs/{logid}/versions/{version}/dataRequest
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
Query Parameters
define format when using JSON data is used. Value can be split, index, columns, records, values
Possible values: Value must match regular expression
split|index|columns|records|valuesDefault:
splitThe json path to the bulk reference (see https://goessner.net/articles/JsonPath/). Required for non wks:log.
Response
- columns
- index
Status Code
Get log bulk data in format in the given orient value. It uses Pandas.Dataframe json format. Here're examples for data with 5 rows and 3 columns with different orient:
- split:
{"columns":["Ref","col_100X","col_200X"],"index":[0,1,2,3,4],"data":[[0.0,1001,2001],[0.5,1002,2002],[1.0,1003,2003],[1.5,1004,2004],[2.0,1005,2005]]}
- index:
{"0":{"Ref":0.0,"col_100X":1001,"col_200X":2001},"1":{"Ref":0.5,"col_100X":1002,"col_200X":2002},"2":{"Ref":1.0,"col_100X":1003,"col_200X":2003},"3":{"Ref":1.5,"col_100X":1004,"col_200X":2004},"4":{"Ref":2.0,"col_100X":1005,"col_200X":2005}}
- columns:
{"Ref":{"0":0.0,"1":0.5,"2":1.0,"3":1.5,"4":2.0},"col_100X":{"0":1001,"1":1002,"2":1003,"3":1004,"4":1005},"col_200X":{"0":2001,"1":2002,"2":2003,"3":2004,"4":2005}}
- records:
[{"Ref":0.0,"col_100X":1001,"col_200X":2001},{"Ref":0.5,"col_100X":1002,"col_200X":2002},{"Ref":1.0,"col_100X":1003,"col_200X":2003},{"Ref":1.5,"col_100X":1004,"col_200X":2004},{"Ref":2.0,"col_100X":1005,"col_200X":2005}]
- values:
[[0.0,1001,2001],[0.5,1002,2002],[1.0,1003,2003],[1.5,1004,2004],[2.0,1005,2005]]
- split:
log not found
Validation Error
{"columns":["Ref","col_100X","col_200X"],"index":[0,1,2,3,4],"data":[[0.0,1001,2001],[0.5,1002,2002],[1.0,1003,2003],[1.5,1004,2004],[2.0,1005,2005]]}
Returns a decimated version of all data within the specified filters. Eventually consistent.
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
GET /ddms/v2/logs/{logid}/decimatedRequest
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
Query Parameters
Number of division desired
The start value for the log decimation
The stop value for the log decimation
define format when using JSON data is used. Value can be split, index, columns, records, values
Possible values: Value must match regular expression
split|index|columns|records|valuesDefault:
splitThe json path to the bulk reference (see https://goessner.net/articles/JsonPath/). Required for non wks:log.
Create or update the DipSets using wks:dipSet:1.0.0 schema
Required roles: 'users.datalake.editors' or 'users.datalake.admins'.
POST /ddms/v2/dipsets
Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
The base model forbids fields which are not declared initially in the pydantic model
[
{
"acl": {
"viewers": [
"data.default.viewers@{{datapartitionid}}.{{domain}}.com"
],
"owners": [
"data.default.owners@{{datapartitionid}}.{{domain}}.com"
]
},
"data": {
"classification": "Externally Processed LogSet",
"name": "myDipSet",
"relationships": {
"well": {
"confidence": 1,
"id": "{{datapartitionid}}:well:myWell",
"name": "myWell"
},
"wellbore": {
"confidence": 1,
"id": "{{datapartitionid}}:wellbore:myWellbore",
"name": "myWellbore"
}
}
},
"id": "{{datapartitionid}}:dipSet:myDipSet",
"kind": "{{datapartitionid}}:wks:dipSet:0.0.1",
"legal": {
"legaltags": [
"{{legaltags}}"
],
"otherRelevantDataCountries": [
"FR",
"US"
],
"status": "compliant"
}
}
]The links to data, which constitute the inputs.
- ancestry
The meta data section linking the 'unitKey', 'crsKey' to self-contained definitions (persistableReference)
The reference entity type as declared in common:metadata:entity:*.
A generic dictionary of string keys mapping to string value. Only strings are permitted as keys and values.
Examples:{ "NameOfKey": "String value" }- tags
Timestamp of the time at which initial version of this OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:46:20.163ZThe user reference, which created the first version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comTimestamp of the time at which this version of the OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:52:24.477ZThe user reference, which created this version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comThe access control tags associated with this entity.
- acl
dipset data
- data
Azimuth reference code defining the type of North. Only used for dipSets with azimuth data
The well-known log set classification code.
Default:
Externally Processed LogSetThe UTC date time of the entity creation
The UTC date time of the last entity modification
The base model forbids fields which are not declared initially in the pydantic model
An array of identities (e.g. some kind if URL to be resolved in an external data store), which links to external realizations of the same entity.
The name of this dip set
The operation which created this entity
The base model forbids fields which are not declared initially in the pydantic model
The reference index type of the dip set.
Used for data model allows extra fields which are not declared initially in the pydantic model
The base model forbids fields which are not declared initially in the pydantic model
The base model forbids fields which are not declared initially in the pydantic model
The base model forbids fields which are not declared initially in the pydantic model
bulkURI either URL or URN.
The unique identifier of the dip set
Kind specification
Default:
osdu:wks:dipSet:0.0.1The dip-set's legal tags
- legal
The list of legal tags, see compliance API.
The list of other relevant data countries using the ISO 2-letter codes, see compliance API.
The legal status.
The version number of this dip set; set by the framework.
Get the given version of DipSet by using wks:dipset:1.0.0 schema
"Get the DipSet object by using its id.
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
GET /ddms/v2/dipsets/{dipsetid}/versions/{version}Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
Response
The base model forbids fields which are not declared initially in the pydantic model
The links to data, which constitute the inputs.
- ancestry
The meta data section linking the 'unitKey', 'crsKey' to self-contained definitions (persistableReference)
The reference entity type as declared in common:metadata:entity:*.
A generic dictionary of string keys mapping to string value. Only strings are permitted as keys and values.
Examples:{ "NameOfKey": "String value" }- tags
Timestamp of the time at which initial version of this OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:46:20.163ZThe user reference, which created the first version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comTimestamp of the time at which this version of the OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:52:24.477ZThe user reference, which created this version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comThe access control tags associated with this entity.
- acl
dipset data
- data
Azimuth reference code defining the type of North. Only used for dipSets with azimuth data
The well-known log set classification code.
The UTC date time of the entity creation
The UTC date time of the last entity modification
The base model forbids fields which are not declared initially in the pydantic model
An array of identities (e.g. some kind if URL to be resolved in an external data store), which links to external realizations of the same entity.
The name of this dip set
The operation which created this entity
The base model forbids fields which are not declared initially in the pydantic model
The reference index type of the dip set.
Used for data model allows extra fields which are not declared initially in the pydantic model
The base model forbids fields which are not declared initially in the pydantic model
The base model forbids fields which are not declared initially in the pydantic model
The base model forbids fields which are not declared initially in the pydantic model
bulkURI either URL or URN.
The unique identifier of the dip set
Kind specification
The dip-set's legal tags
- legal
The list of legal tags, see compliance API.
The list of other relevant data countries using the ISO 2-letter codes, see compliance API.
The legal status.
The version number of this dip set; set by the framework.
Status Code
Successful Response
DipSet not found
Validation Error
No Sample Response
Get all versions of the dipset
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
GET /ddms/v2/dipsets/{dipsetid}/versionsGet the DipSet by using wks:dipSet:1.0.0 schema
Get the DipSet object using its id.
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
GET /ddms/v2/dipsets/{dipsetid}Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
Response
The base model forbids fields which are not declared initially in the pydantic model
The links to data, which constitute the inputs.
- ancestry
The meta data section linking the 'unitKey', 'crsKey' to self-contained definitions (persistableReference)
The reference entity type as declared in common:metadata:entity:*.
A generic dictionary of string keys mapping to string value. Only strings are permitted as keys and values.
Examples:{ "NameOfKey": "String value" }- tags
Timestamp of the time at which initial version of this OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:46:20.163ZThe user reference, which created the first version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comTimestamp of the time at which this version of the OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:52:24.477ZThe user reference, which created this version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comThe access control tags associated with this entity.
- acl
dipset data
- data
Azimuth reference code defining the type of North. Only used for dipSets with azimuth data
The well-known log set classification code.
The UTC date time of the entity creation
The UTC date time of the last entity modification
The base model forbids fields which are not declared initially in the pydantic model
An array of identities (e.g. some kind if URL to be resolved in an external data store), which links to external realizations of the same entity.
The name of this dip set
The operation which created this entity
The base model forbids fields which are not declared initially in the pydantic model
The reference index type of the dip set.
Used for data model allows extra fields which are not declared initially in the pydantic model
The base model forbids fields which are not declared initially in the pydantic model
The base model forbids fields which are not declared initially in the pydantic model
The base model forbids fields which are not declared initially in the pydantic model
bulkURI either URL or URN.
The unique identifier of the dip set
Kind specification
The dip-set's legal tags
- legal
The list of legal tags, see compliance API.
The list of other relevant data countries using the ISO 2-letter codes, see compliance API.
The legal status.
The version number of this dip set; set by the framework.
Status Code
Successful Response
DipSet not found
Validation Error
No Sample Response
Delete the DipSet. The API performs a logical deletion of the given record.
Required roles: 'users.datalake.editors' or 'users.datalake.admins'.
DELETE /ddms/v2/dipsets/{dipsetid}Get dips
Return dips from a dipset from the given index until the given number of dips specifed in query parameters. If not specified returns all dips from a dipset.
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
GET /ddms/v2/dipsets/{dipsetid}/dipsRequest
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
Query Parameters
Possible values: value ≥ 0
Possible values: value ≥ 0
Response
Only Measured Depth in meter is supported for the moment
- reference
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only degrees unit is supported for the moment
- azimuth
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only degrees unit is supported for the moment
- inclination
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Decimal number between 0 and 1
- quality
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only meter unit is supported for the moment
- xCoordinate
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only meter unit is supported for the moment
- yCoordinate
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only meter unit is supported for the moment
- zCoordinate
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Any string is accepted.
Status Code
Successful Response
DipSet not found
Validation Error
No Sample Response
Define the dips of the dipset
Replace previous dips by provided dips. Sort dips by reference and azimuth.
Required roles: 'users.datalake.editors' or 'users.datalake.admins'.
POST /ddms/v2/dipsets/{dipsetid}/dipsRequest
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
The ID of the dipset
Only Measured Depth in meter is supported for the moment
- reference
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only degrees unit is supported for the moment
- azimuth
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only degrees unit is supported for the moment
- inclination
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Decimal number between 0 and 1
- quality
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only meter unit is supported for the moment
- xCoordinate
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only meter unit is supported for the moment
- yCoordinate
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only meter unit is supported for the moment
- zCoordinate
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Any string is accepted.
Response
Only Measured Depth in meter is supported for the moment
- reference
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only degrees unit is supported for the moment
- azimuth
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only degrees unit is supported for the moment
- inclination
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Decimal number between 0 and 1
- quality
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only meter unit is supported for the moment
- xCoordinate
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only meter unit is supported for the moment
- yCoordinate
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only meter unit is supported for the moment
- zCoordinate
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Any string is accepted.
Status Code
Successful Response
Validation Error
No Sample Response
Insert dip in a dipset
Insert dips in dipset. Existing dips are not replaced. Several dip can have same reference. Operation will sort by reference all dips in dipset (may modify dip indexes).
Required roles: 'users.datalake.editors' or 'users.datalake.admins'.
POST /ddms/v2/dipsets/{dipsetid}/dips/insertRequest
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
Only Measured Depth in meter is supported for the moment
- reference
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only degrees unit is supported for the moment
- azimuth
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only degrees unit is supported for the moment
- inclination
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Decimal number between 0 and 1
- quality
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only meter unit is supported for the moment
- xCoordinate
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only meter unit is supported for the moment
- yCoordinate
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only meter unit is supported for the moment
- zCoordinate
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Any string is accepted.
Response
Only Measured Depth in meter is supported for the moment
- reference
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only degrees unit is supported for the moment
- azimuth
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only degrees unit is supported for the moment
- inclination
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Decimal number between 0 and 1
- quality
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only meter unit is supported for the moment
- xCoordinate
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only meter unit is supported for the moment
- yCoordinate
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only meter unit is supported for the moment
- zCoordinate
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Any string is accepted.
Status Code
Successful Response
Validation Error
No Sample Response
Query dip from a dipset
Search dip within reference interval and specific classification.
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
GET /ddms/v2/dipsets/{dipsetid}/dips/queryRequest
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
Query Parameters
Min reference for the dips to search in the dipset
Response
Only Measured Depth in meter is supported for the moment
- reference
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only degrees unit is supported for the moment
- azimuth
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only degrees unit is supported for the moment
- inclination
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Decimal number between 0 and 1
- quality
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only meter unit is supported for the moment
- xCoordinate
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only meter unit is supported for the moment
- yCoordinate
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only meter unit is supported for the moment
- zCoordinate
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Any string is accepted.
Status Code
Successful Response
Validation Error
No Sample Response
Get a dip at at the given index
"Return dip from dipset at the given index.
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
GET /ddms/v2/dipsets/{dipsetid}/dips/{index}Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
Response
Only Measured Depth in meter is supported for the moment
- reference
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only degrees unit is supported for the moment
- azimuth
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only degrees unit is supported for the moment
- inclination
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Decimal number between 0 and 1
- quality
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only meter unit is supported for the moment
- xCoordinate
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only meter unit is supported for the moment
- yCoordinate
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only meter unit is supported for the moment
- zCoordinate
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Any string is accepted.
Status Code
Successful Response
DipSet or index not found
Validation Error
{ "reference": { "unitKey": "meter", "value": 1000.5 }, "azimuth": { "unitKey": "dega", "value": 42 }, "inclination": { "unitKey": "dega", "value": 9 }, "quality": { "unitKey": "unitless", "value": 0.5 }, "xCoordinate": { "unitKey": "meter", "value": 2 }, "yCoordinate": { "unitKey": "meter", "value": 45 }, "zCoordinate": { "unitKey": "meter", "value": 7 }, "classification": "fracture" }
Delete a dip
Removes the dip at index.
Required roles: 'users.datalake.editors' or 'users.datalake.admins'.
DELETE /ddms/v2/dipsets/{dipsetid}/dips/{index}Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
Response
Only Measured Depth in meter is supported for the moment
- reference
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only degrees unit is supported for the moment
- azimuth
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only degrees unit is supported for the moment
- inclination
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Decimal number between 0 and 1
- quality
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only meter unit is supported for the moment
- xCoordinate
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only meter unit is supported for the moment
- yCoordinate
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only meter unit is supported for the moment
- zCoordinate
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Any string is accepted.
Status Code
Successful Response
DipSet or index not found
Validation Error
No Sample Response
Update a dip
"Update a dip at index. Operation will sort by reference all dips in a dipset (may modify dip indexes).
PATCH /ddms/v2/dipsets/{dipsetid}/dips/{index}Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
{
"reference": {
"unitKey": "meter",
"value": 1000.5
},
"azimuth": {
"unitKey": "dega",
"value": 42
},
"inclination": {
"unitKey": "dega",
"value": 9
},
"quality": {
"unitKey": "unitless",
"value": 0.5
},
"xCoordinate": {
"unitKey": "meter",
"value": 2
},
"yCoordinate": {
"unitKey": "meter",
"value": 45
},
"zCoordinate": {
"unitKey": "meter",
"value": 7
},
"classification": "fracture"
}Only Measured Depth in meter is supported for the moment
- reference
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only degrees unit is supported for the moment
- azimuth
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only degrees unit is supported for the moment
- inclination
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Decimal number between 0 and 1
- quality
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only meter unit is supported for the moment
- xCoordinate
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only meter unit is supported for the moment
- yCoordinate
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only meter unit is supported for the moment
- zCoordinate
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Any string is accepted.
Response
Only Measured Depth in meter is supported for the moment
- reference
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only degrees unit is supported for the moment
- azimuth
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only degrees unit is supported for the moment
- inclination
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Decimal number between 0 and 1
- quality
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only meter unit is supported for the moment
- xCoordinate
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only meter unit is supported for the moment
- yCoordinate
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Only meter unit is supported for the moment
- zCoordinate
Unit for value of the corresponding attribute for the domain object in question. The key can be looked up in the 'frameOfReference.units' for further details.
Value of the corresponding attribute for the domain object in question.
Any string is accepted.
Status Code
Successful Response
DipSet not found
Validation Error
No Sample Response
Get the Wellbore using identifier
Get the Wellbore object using its id.
If the id is a Delfi Wellbore Id, tries to convert it on the fly to return the Wellbore as an osdu Wellbore.
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
GET /ddms/v3/wellbores/{wellboreid}Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
Response
A hole in the ground extending from a point at the earth's surface to the maximum point of penetration.
The schema identification for the OSDU resource object following the pattern {Namespace}:{Source}:{Type}:{VersionMajor}.{VersionMinor}.{VersionPatch}. The versioning scheme follows the semantic versioning, https://semver.org/.
Possible values: Value must match regular expression
^[\w\-\.]+:[\w\-\.]+:[\w\-\.]+:[0-9]+.[0-9]+.[0-9]+$Example:
osdu:wks:master-data--Wellbore:1.0.0The access control tags associated with this entity.
- acl
The list of owners of this data record formatted as an email (core.common.model.storage.validation.ValidationDoc.EMAIL_REGEX).
Possible values: Value must match regular expression
^[a-zA-Z0-9_+&*-]+(?:\.[a-zA-Z0-9_+&*-]+)*@(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]{2,7}$The list of viewers to which this data record is accessible/visible/discoverable formatted as an email (core.common.model.storage.validation.ValidationDoc.EMAIL_REGEX).
Possible values: Value must match regular expression
^[a-zA-Z0-9_+&*-]+(?:\.[a-zA-Z0-9_+&*-]+)*@(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]{2,7}$
The entity's legal tags and compliance status. The actual contents associated with the legal tags is managed by the Compliance Service.
- legal
The list of legal tags, which resolve to legal properties (like country of origin, export classification code, etc.) and rules with the help of the Compliance Service.
The list of other relevant data countries as an array of two-letter country codes, see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.
Possible values: Value must match regular expression
^[A-Z]{2}$The legal status. Set by the system after evaluation against the compliance rules associated with the "legaltags" using the Compliance Service.
Possible values: Value must match regular expression
^(compliant|uncompliant)$
Previously called ResourceID or SRN which identifies this OSDU resource object without version.
Possible values: Value must match regular expression
^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+$Example:
namespace:master-data--Wellbore:c7c421a7-f496-5aef-8093-298c32bfdea9The version number of this OSDU resource; set by the framework.
Example:
1562066009929332A generic dictionary of string keys mapping to string value. Only strings are permitted as keys and values.
Examples:{ "NameOfKey": "String value" }- tags
Timestamp of the time at which initial version of this OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:46:20.163ZThe user reference, which created the first version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comTimestamp of the time at which this version of the OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:52:24.477ZThe user reference, which created this version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comThe links to data, which constitute the inputs.
- ancestry
An array of none, one or many entity references in the data ecosystem, which identify the source of data in the legal sense. In contract to other relationships, the source record version is required. Example: the 'parents' will be queried when e.g. the subscription of source data services is terminated; access to the derivatives is also terminated.
Possible values: Value must match regular expression
^[\w\-\.]+:[\w\-\.]+:[\w\-\.\:\%]+:[0-9]+$Example:
[]
The Frame of Reference meta data section linking the named properties to self-contained definitions.
Common resources to be injected at root 'data' level for every entity, which is persistable in Storage. The insertion is performed by the OsduSchemaComposer script.
Status Code
Successful Response
Wellbore not found
Validation Error
No Sample Response
Delete the wellbore. The API performs a logical deletion of the given record. There is no recursive deletion for the OSDU kinds.
Required roles: 'users.datalake.editors' or 'users.datalake.admins'.
DELETE /ddms/v3/wellbores/{wellboreid}Get all versions of the Wellbore
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
GET /ddms/v3/wellbores/{wellboreid}/versionsGet the given version of the Wellbore using OSDU wellbore schema
"Get the Wellbore object using its id.
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
GET /ddms/v3/wellbores/{wellboreid}/versions/{version}Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
Response
A hole in the ground extending from a point at the earth's surface to the maximum point of penetration.
The schema identification for the OSDU resource object following the pattern {Namespace}:{Source}:{Type}:{VersionMajor}.{VersionMinor}.{VersionPatch}. The versioning scheme follows the semantic versioning, https://semver.org/.
Possible values: Value must match regular expression
^[\w\-\.]+:[\w\-\.]+:[\w\-\.]+:[0-9]+.[0-9]+.[0-9]+$Example:
osdu:wks:master-data--Wellbore:1.0.0The access control tags associated with this entity.
- acl
The list of owners of this data record formatted as an email (core.common.model.storage.validation.ValidationDoc.EMAIL_REGEX).
Possible values: Value must match regular expression
^[a-zA-Z0-9_+&*-]+(?:\.[a-zA-Z0-9_+&*-]+)*@(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]{2,7}$The list of viewers to which this data record is accessible/visible/discoverable formatted as an email (core.common.model.storage.validation.ValidationDoc.EMAIL_REGEX).
Possible values: Value must match regular expression
^[a-zA-Z0-9_+&*-]+(?:\.[a-zA-Z0-9_+&*-]+)*@(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]{2,7}$
The entity's legal tags and compliance status. The actual contents associated with the legal tags is managed by the Compliance Service.
- legal
The list of legal tags, which resolve to legal properties (like country of origin, export classification code, etc.) and rules with the help of the Compliance Service.
The list of other relevant data countries as an array of two-letter country codes, see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.
Possible values: Value must match regular expression
^[A-Z]{2}$The legal status. Set by the system after evaluation against the compliance rules associated with the "legaltags" using the Compliance Service.
Possible values: Value must match regular expression
^(compliant|uncompliant)$
Previously called ResourceID or SRN which identifies this OSDU resource object without version.
Possible values: Value must match regular expression
^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+$Example:
namespace:master-data--Wellbore:c7c421a7-f496-5aef-8093-298c32bfdea9The version number of this OSDU resource; set by the framework.
Example:
1562066009929332A generic dictionary of string keys mapping to string value. Only strings are permitted as keys and values.
Examples:{ "NameOfKey": "String value" }- tags
Timestamp of the time at which initial version of this OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:46:20.163ZThe user reference, which created the first version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comTimestamp of the time at which this version of the OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:52:24.477ZThe user reference, which created this version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comThe links to data, which constitute the inputs.
- ancestry
An array of none, one or many entity references in the data ecosystem, which identify the source of data in the legal sense. In contract to other relationships, the source record version is required. Example: the 'parents' will be queried when e.g. the subscription of source data services is terminated; access to the derivatives is also terminated.
Possible values: Value must match regular expression
^[\w\-\.]+:[\w\-\.]+:[\w\-\.\:\%]+:[0-9]+$Example:
[]
The Frame of Reference meta data section linking the named properties to self-contained definitions.
Common resources to be injected at root 'data' level for every entity, which is persistable in Storage. The insertion is performed by the OsduSchemaComposer script.
Status Code
Successful Response
Wellbore not found
Validation Error
No Sample Response
Create or update the Wellbores
Required roles: 'users.datalake.editors' or 'users.datalake.admins'.
POST /ddms/v3/wellbores
Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
A hole in the ground extending from a point at the earth's surface to the maximum point of penetration.
[
{
"acl": {
"viewers": [
"data.default.viewers@{{datapartitionid}}.{{domain}}"
],
"owners": [
"data.default.owners@{{datapartitionid}}.{{domain}}"
]
},
"id": "{{datapartitionid}}:master-data--Wellbore:{{wellboreId}}:",
"kind": "osdu:wks:master-data--Wellbore:1.0.0",
"legal": {
"legaltags": [
"{{legaltags}}"
],
"otherRelevantDataCountries": [
"FR",
"US"
]
},
"data": {
"ExtensionProperties": {
"airGap": {
"unitKey": "ft",
"value": 35
},
"country": "United States of America",
"operator": "Francois Vinyes",
"uwi": "33-089-00300-00-01",
"wellboreType": "bypass"
},
"SpatialLocation": {
"Wgs84Coordinates": {
"features": [
{
"geometry": {
"coordinates": [
[
-103.2380248,
46.8925081,
5301
],
[
-103.2380248,
46.8925081,
2801
],
[
-103.2378748,
46.892608100000004,
301
],
[
-103.23742477750001,
46.89270811,
-2199
],
[
-103.23667470999663,
46.892808120001,
-4699
],
[
-103.2356245974865,
46.892908130002,
-7199
]
],
"type": "LineString"
},
"properties": {
"name": "Newton 2-31-Lat-1"
},
"type": "Feature"
}
],
"type": "FeatureCollection"
}
},
"FacilityName": "{{wellboreName}}",
"WellID": "{{datapartitionid}}:master-data--Well:{{wellId}}:"
},
"meta": [
{
"kind": "Unit",
"name": "Measure depth default unit",
"persistableReference": "persistableReference",
"propertyNames": [
"symbol"
],
"propertyValues": [
"ft"
]
}
]
}
]The schema identification for the OSDU resource object following the pattern {Namespace}:{Source}:{Type}:{VersionMajor}.{VersionMinor}.{VersionPatch}. The versioning scheme follows the semantic versioning, https://semver.org/.
Possible values: Value must match regular expression
^[\w\-\.]+:[\w\-\.]+:[\w\-\.]+:[0-9]+.[0-9]+.[0-9]+$Example:
osdu:wks:master-data--Wellbore:1.0.0The access control tags associated with this entity.
- acl
The list of owners of this data record formatted as an email (core.common.model.storage.validation.ValidationDoc.EMAIL_REGEX).
Possible values: Value must match regular expression
^[a-zA-Z0-9_+&*-]+(?:\.[a-zA-Z0-9_+&*-]+)*@(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]{2,7}$The list of viewers to which this data record is accessible/visible/discoverable formatted as an email (core.common.model.storage.validation.ValidationDoc.EMAIL_REGEX).
Possible values: Value must match regular expression
^[a-zA-Z0-9_+&*-]+(?:\.[a-zA-Z0-9_+&*-]+)*@(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]{2,7}$
The entity's legal tags and compliance status. The actual contents associated with the legal tags is managed by the Compliance Service.
- legal
The list of legal tags, which resolve to legal properties (like country of origin, export classification code, etc.) and rules with the help of the Compliance Service.
The list of other relevant data countries as an array of two-letter country codes, see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.
Possible values: Value must match regular expression
^[A-Z]{2}$The legal status. Set by the system after evaluation against the compliance rules associated with the "legaltags" using the Compliance Service.
Possible values: Value must match regular expression
^(compliant|uncompliant)$
Previously called ResourceID or SRN which identifies this OSDU resource object without version.
Possible values: Value must match regular expression
^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+$Example:
namespace:master-data--Wellbore:c7c421a7-f496-5aef-8093-298c32bfdea9The version number of this OSDU resource; set by the framework.
Example:
1562066009929332A generic dictionary of string keys mapping to string value. Only strings are permitted as keys and values.
Examples:{ "NameOfKey": "String value" }- tags
Timestamp of the time at which initial version of this OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:46:20.163ZThe user reference, which created the first version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comTimestamp of the time at which this version of the OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:52:24.477ZThe user reference, which created this version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comThe links to data, which constitute the inputs.
- ancestry
An array of none, one or many entity references in the data ecosystem, which identify the source of data in the legal sense. In contract to other relationships, the source record version is required. Example: the 'parents' will be queried when e.g. the subscription of source data services is terminated; access to the derivatives is also terminated.
Possible values: Value must match regular expression
^[\w\-\.]+:[\w\-\.]+:[\w\-\.\:\%]+:[0-9]+$Example:
[]
The Frame of Reference meta data section linking the named properties to self-contained definitions.
Common resources to be injected at root 'data' level for every entity, which is persistable in Storage. The insertion is performed by the OsduSchemaComposer script.
Get the Well using identifier
Get the Well object using its id.
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
GET /ddms/v3/wells/{wellid}Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
Response
The origin of a set of wellbores.
The schema identification for the OSDU resource object following the pattern {Namespace}:{Source}:{Type}:{VersionMajor}.{VersionMinor}.{VersionPatch}. The versioning scheme follows the semantic versioning, https://semver.org/.
Possible values: Value must match regular expression
^[\w\-\.]+:[\w\-\.]+:[\w\-\.]+:[0-9]+.[0-9]+.[0-9]+$Example:
osdu:wks:master-data--Well:1.0.0The access control tags associated with this entity.
- acl
The list of owners of this data record formatted as an email (core.common.model.storage.validation.ValidationDoc.EMAIL_REGEX).
Possible values: Value must match regular expression
^[a-zA-Z0-9_+&*-]+(?:\.[a-zA-Z0-9_+&*-]+)*@(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]{2,7}$The list of viewers to which this data record is accessible/visible/discoverable formatted as an email (core.common.model.storage.validation.ValidationDoc.EMAIL_REGEX).
Possible values: Value must match regular expression
^[a-zA-Z0-9_+&*-]+(?:\.[a-zA-Z0-9_+&*-]+)*@(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]{2,7}$
The entity's legal tags and compliance status. The actual contents associated with the legal tags is managed by the Compliance Service.
- legal
The list of legal tags, which resolve to legal properties (like country of origin, export classification code, etc.) and rules with the help of the Compliance Service.
The list of other relevant data countries as an array of two-letter country codes, see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.
Possible values: Value must match regular expression
^[A-Z]{2}$The legal status. Set by the system after evaluation against the compliance rules associated with the "legaltags" using the Compliance Service.
Possible values: Value must match regular expression
^(compliant|uncompliant)$
Previously called ResourceID or SRN which identifies this OSDU resource object without version.
Possible values: Value must match regular expression
^[\w\-\.]+:master-data\-\-Well:[\w\-\.\:\%]+$Example:
namespace:master-data--Well:6c60ceb0-3521-57b7-9bd8-e1d7c9f66230The version number of this OSDU resource; set by the framework.
Example:
1562066009929332A generic dictionary of string keys mapping to string value. Only strings are permitted as keys and values.
Examples:{ "NameOfKey": "String value" }- tags
Timestamp of the time at which initial version of this OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:46:20.163ZThe user reference, which created the first version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comTimestamp of the time at which this version of the OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:52:24.477ZThe user reference, which created this version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comThe links to data, which constitute the inputs.
- ancestry
An array of none, one or many entity references in the data ecosystem, which identify the source of data in the legal sense. In contract to other relationships, the source record version is required. Example: the 'parents' will be queried when e.g. the subscription of source data services is terminated; access to the derivatives is also terminated.
Possible values: Value must match regular expression
^[\w\-\.]+:[\w\-\.]+:[\w\-\.\:\%]+:[0-9]+$Example:
[]
The Frame of Reference meta data section linking the named properties to self-contained definitions.
Common resources to be injected at root 'data' level for every entity, which is persistable in Storage. The insertion is performed by the OsduSchemaComposer script.
Status Code
Successful Response
Well not found
Validation Error
No Sample Response
Delete the well. The API performs a logical deletion of the given record. No recursive delete for OSDU kinds
Required roles: 'users.datalake.editors' or 'users.datalake.admins'.
DELETE /ddms/v3/wells/{wellid}Get all versions of the Well
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
GET /ddms/v3/wells/{wellid}/versionsGet the given version of the Well using OSDU well schema
"Get the Well object using its id.
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
GET /ddms/v3/wells/{wellid}/versions/{version}Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
Response
The origin of a set of wellbores.
The schema identification for the OSDU resource object following the pattern {Namespace}:{Source}:{Type}:{VersionMajor}.{VersionMinor}.{VersionPatch}. The versioning scheme follows the semantic versioning, https://semver.org/.
Possible values: Value must match regular expression
^[\w\-\.]+:[\w\-\.]+:[\w\-\.]+:[0-9]+.[0-9]+.[0-9]+$Example:
osdu:wks:master-data--Well:1.0.0The access control tags associated with this entity.
- acl
The list of owners of this data record formatted as an email (core.common.model.storage.validation.ValidationDoc.EMAIL_REGEX).
Possible values: Value must match regular expression
^[a-zA-Z0-9_+&*-]+(?:\.[a-zA-Z0-9_+&*-]+)*@(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]{2,7}$The list of viewers to which this data record is accessible/visible/discoverable formatted as an email (core.common.model.storage.validation.ValidationDoc.EMAIL_REGEX).
Possible values: Value must match regular expression
^[a-zA-Z0-9_+&*-]+(?:\.[a-zA-Z0-9_+&*-]+)*@(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]{2,7}$
The entity's legal tags and compliance status. The actual contents associated with the legal tags is managed by the Compliance Service.
- legal
The list of legal tags, which resolve to legal properties (like country of origin, export classification code, etc.) and rules with the help of the Compliance Service.
The list of other relevant data countries as an array of two-letter country codes, see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.
Possible values: Value must match regular expression
^[A-Z]{2}$The legal status. Set by the system after evaluation against the compliance rules associated with the "legaltags" using the Compliance Service.
Possible values: Value must match regular expression
^(compliant|uncompliant)$
Previously called ResourceID or SRN which identifies this OSDU resource object without version.
Possible values: Value must match regular expression
^[\w\-\.]+:master-data\-\-Well:[\w\-\.\:\%]+$Example:
namespace:master-data--Well:6c60ceb0-3521-57b7-9bd8-e1d7c9f66230The version number of this OSDU resource; set by the framework.
Example:
1562066009929332A generic dictionary of string keys mapping to string value. Only strings are permitted as keys and values.
Examples:{ "NameOfKey": "String value" }- tags
Timestamp of the time at which initial version of this OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:46:20.163ZThe user reference, which created the first version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comTimestamp of the time at which this version of the OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:52:24.477ZThe user reference, which created this version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comThe links to data, which constitute the inputs.
- ancestry
An array of none, one or many entity references in the data ecosystem, which identify the source of data in the legal sense. In contract to other relationships, the source record version is required. Example: the 'parents' will be queried when e.g. the subscription of source data services is terminated; access to the derivatives is also terminated.
Possible values: Value must match regular expression
^[\w\-\.]+:[\w\-\.]+:[\w\-\.\:\%]+:[0-9]+$Example:
[]
The Frame of Reference meta data section linking the named properties to self-contained definitions.
Common resources to be injected at root 'data' level for every entity, which is persistable in Storage. The insertion is performed by the OsduSchemaComposer script.
Status Code
Successful Response
Well not found
Validation Error
No Sample Response
Create or update the Wells
Required roles: 'users.datalake.editors' or 'users.datalake.admins'.
POST /ddms/v3/wells
Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
The origin of a set of wellbores.
[
{
"acl": {
"viewers": [
"data.default.viewers@{{datapartitionid}}.{{domain}}"
],
"owners": [
"data.default.owners@{{datapartitionid}}.{{domain}}"
]
},
"data": {
"FacilityName": "{{wellName}}",
"ExtensionProperties": {
"UWI": "20-000-00000-00"
}
},
"id": "{{datapartitionid}}:master-data--Well:{{wellId}}",
"kind": "osdu:wks:master-data--Well:1.0.0",
"legal": {
"legaltags": [
"{{legaltags}}"
],
"otherRelevantDataCountries": [
"FR",
"US"
],
"status": "compliant"
}
}
]The schema identification for the OSDU resource object following the pattern {Namespace}:{Source}:{Type}:{VersionMajor}.{VersionMinor}.{VersionPatch}. The versioning scheme follows the semantic versioning, https://semver.org/.
Possible values: Value must match regular expression
^[\w\-\.]+:[\w\-\.]+:[\w\-\.]+:[0-9]+.[0-9]+.[0-9]+$Example:
osdu:wks:master-data--Well:1.0.0The access control tags associated with this entity.
- acl
The list of owners of this data record formatted as an email (core.common.model.storage.validation.ValidationDoc.EMAIL_REGEX).
Possible values: Value must match regular expression
^[a-zA-Z0-9_+&*-]+(?:\.[a-zA-Z0-9_+&*-]+)*@(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]{2,7}$The list of viewers to which this data record is accessible/visible/discoverable formatted as an email (core.common.model.storage.validation.ValidationDoc.EMAIL_REGEX).
Possible values: Value must match regular expression
^[a-zA-Z0-9_+&*-]+(?:\.[a-zA-Z0-9_+&*-]+)*@(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]{2,7}$
The entity's legal tags and compliance status. The actual contents associated with the legal tags is managed by the Compliance Service.
- legal
The list of legal tags, which resolve to legal properties (like country of origin, export classification code, etc.) and rules with the help of the Compliance Service.
The list of other relevant data countries as an array of two-letter country codes, see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.
Possible values: Value must match regular expression
^[A-Z]{2}$The legal status. Set by the system after evaluation against the compliance rules associated with the "legaltags" using the Compliance Service.
Possible values: Value must match regular expression
^(compliant|uncompliant)$
Previously called ResourceID or SRN which identifies this OSDU resource object without version.
Possible values: Value must match regular expression
^[\w\-\.]+:master-data\-\-Well:[\w\-\.\:\%]+$Example:
namespace:master-data--Well:6c60ceb0-3521-57b7-9bd8-e1d7c9f66230The version number of this OSDU resource; set by the framework.
Example:
1562066009929332A generic dictionary of string keys mapping to string value. Only strings are permitted as keys and values.
Examples:{ "NameOfKey": "String value" }- tags
Timestamp of the time at which initial version of this OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:46:20.163ZThe user reference, which created the first version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comTimestamp of the time at which this version of the OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:52:24.477ZThe user reference, which created this version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comThe links to data, which constitute the inputs.
- ancestry
An array of none, one or many entity references in the data ecosystem, which identify the source of data in the legal sense. In contract to other relationships, the source record version is required. Example: the 'parents' will be queried when e.g. the subscription of source data services is terminated; access to the derivatives is also terminated.
Possible values: Value must match regular expression
^[\w\-\.]+:[\w\-\.]+:[\w\-\.\:\%]+:[0-9]+$Example:
[]
The Frame of Reference meta data section linking the named properties to self-contained definitions.
Common resources to be injected at root 'data' level for every entity, which is persistable in Storage. The insertion is performed by the OsduSchemaComposer script.
Get the WellLog using identifier
Get the WellLog object using its id.
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
GET /ddms/v3/welllogs/{welllogid}Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
Response
The schema identification for the OSDU resource object following the pattern {Namespace}:{Source}:{Type}:{VersionMajor}.{VersionMinor}.{VersionPatch}. The versioning scheme follows the semantic versioning, https://semver.org/.
Possible values: Value must match regular expression
^[\w\-\.]+:[\w\-\.]+:[\w\-\.]+:[0-9]+.[0-9]+.[0-9]+$Example:
osdu:wks:work-product-component--WellLog:1.0.0The access control tags associated with this entity.
- acl
The list of owners of this data record formatted as an email (core.common.model.storage.validation.ValidationDoc.EMAIL_REGEX).
Possible values: Value must match regular expression
^[a-zA-Z0-9_+&*-]+(?:\.[a-zA-Z0-9_+&*-]+)*@(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]{2,7}$The list of viewers to which this data record is accessible/visible/discoverable formatted as an email (core.common.model.storage.validation.ValidationDoc.EMAIL_REGEX).
Possible values: Value must match regular expression
^[a-zA-Z0-9_+&*-]+(?:\.[a-zA-Z0-9_+&*-]+)*@(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]{2,7}$
The entity's legal tags and compliance status. The actual contents associated with the legal tags is managed by the Compliance Service.
- legal
The list of legal tags, which resolve to legal properties (like country of origin, export classification code, etc.) and rules with the help of the Compliance Service.
The list of other relevant data countries as an array of two-letter country codes, see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.
Possible values: Value must match regular expression
^[A-Z]{2}$The legal status. Set by the system after evaluation against the compliance rules associated with the "legaltags" using the Compliance Service.
Possible values: Value must match regular expression
^(compliant|uncompliant)$
Previously called ResourceID or SRN which identifies this OSDU resource object without version.
Possible values: Value must match regular expression
^[\w\-\.]+:work-product-component\-\-WellLog:[\w\-\.\:\%]+$Example:
namespace:work-product-component--WellLog:c2c79f1c-90ca-5c92-b8df-04dbe438f414The version number of this OSDU resource; set by the framework.
Example:
1562066009929332A generic dictionary of string keys mapping to string value. Only strings are permitted as keys and values.
Examples:{ "NameOfKey": "String value" }- tags
Timestamp of the time at which initial version of this OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:46:20.163ZThe user reference, which created the first version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comTimestamp of the time at which this version of the OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:52:24.477ZThe user reference, which created this version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comThe links to data, which constitute the inputs.
- ancestry
An array of none, one or many entity references in the data ecosystem, which identify the source of data in the legal sense. In contract to other relationships, the source record version is required. Example: the 'parents' will be queried when e.g. the subscription of source data services is terminated; access to the derivatives is also terminated.
Possible values: Value must match regular expression
^[\w\-\.]+:[\w\-\.]+:[\w\-\.\:\%]+:[0-9]+$Example:
[]
The Frame of Reference meta data section linking the named properties to self-contained definitions.
Common resources to be injected at root 'data' level for every entity, which is persistable in Storage. The insertion is performed by the OsduSchemaComposer script.
Status Code
Successful Response
WellLog not found
Validation Error
No Sample Response
Delete the welllog. The API performs a logical deletion of the given record. No recursive delete for OSDU kinds
Required roles: 'users.datalake.editors' or 'users.datalake.admins'.
DELETE /ddms/v3/welllogs/{welllogid}Get all versions of the WellLog
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
GET /ddms/v3/welllogs/{welllogid}/versionsGet the given version of the WellLog using OSDU welllog schema
"Get the WellLog object using its id.
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
GET /ddms/v3/welllogs/{welllogid}/versions/{version}Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
Response
The schema identification for the OSDU resource object following the pattern {Namespace}:{Source}:{Type}:{VersionMajor}.{VersionMinor}.{VersionPatch}. The versioning scheme follows the semantic versioning, https://semver.org/.
Possible values: Value must match regular expression
^[\w\-\.]+:[\w\-\.]+:[\w\-\.]+:[0-9]+.[0-9]+.[0-9]+$Example:
osdu:wks:work-product-component--WellLog:1.0.0The access control tags associated with this entity.
- acl
The list of owners of this data record formatted as an email (core.common.model.storage.validation.ValidationDoc.EMAIL_REGEX).
Possible values: Value must match regular expression
^[a-zA-Z0-9_+&*-]+(?:\.[a-zA-Z0-9_+&*-]+)*@(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]{2,7}$The list of viewers to which this data record is accessible/visible/discoverable formatted as an email (core.common.model.storage.validation.ValidationDoc.EMAIL_REGEX).
Possible values: Value must match regular expression
^[a-zA-Z0-9_+&*-]+(?:\.[a-zA-Z0-9_+&*-]+)*@(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]{2,7}$
The entity's legal tags and compliance status. The actual contents associated with the legal tags is managed by the Compliance Service.
- legal
The list of legal tags, which resolve to legal properties (like country of origin, export classification code, etc.) and rules with the help of the Compliance Service.
The list of other relevant data countries as an array of two-letter country codes, see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.
Possible values: Value must match regular expression
^[A-Z]{2}$The legal status. Set by the system after evaluation against the compliance rules associated with the "legaltags" using the Compliance Service.
Possible values: Value must match regular expression
^(compliant|uncompliant)$
Previously called ResourceID or SRN which identifies this OSDU resource object without version.
Possible values: Value must match regular expression
^[\w\-\.]+:work-product-component\-\-WellLog:[\w\-\.\:\%]+$Example:
namespace:work-product-component--WellLog:c2c79f1c-90ca-5c92-b8df-04dbe438f414The version number of this OSDU resource; set by the framework.
Example:
1562066009929332A generic dictionary of string keys mapping to string value. Only strings are permitted as keys and values.
Examples:{ "NameOfKey": "String value" }- tags
Timestamp of the time at which initial version of this OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:46:20.163ZThe user reference, which created the first version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comTimestamp of the time at which this version of the OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:52:24.477ZThe user reference, which created this version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comThe links to data, which constitute the inputs.
- ancestry
An array of none, one or many entity references in the data ecosystem, which identify the source of data in the legal sense. In contract to other relationships, the source record version is required. Example: the 'parents' will be queried when e.g. the subscription of source data services is terminated; access to the derivatives is also terminated.
Possible values: Value must match regular expression
^[\w\-\.]+:[\w\-\.]+:[\w\-\.\:\%]+:[0-9]+$Example:
[]
The Frame of Reference meta data section linking the named properties to self-contained definitions.
Common resources to be injected at root 'data' level for every entity, which is persistable in Storage. The insertion is performed by the OsduSchemaComposer script.
Status Code
Successful Response
WellLog not found
Validation Error
No Sample Response
Create or update the WellLogs
Required roles: 'users.datalake.editors' or 'users.datalake.admins'.
POST /ddms/v3/welllogs
Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
[
{
"acl": {
"viewers": [
"data.default.viewers@{{datapartitionid}}.{{domain}}"
],
"owners": [
"data.default.owners@{{datapartitionid}}.{{domain}}"
]
},
"data": {
"Curves": [
{
"CurveID": "GR_ID",
"Mnemonic": "GR",
"CurveUnit": "{{datapartitionid}}:reference-data--UnitOfMeasure:m:",
"LogCurveFamilyID": "{{datapartitionid}}:reference-data--LogCurveFamily:GammaRay:"
},
{
"CurveID": "POR_ID",
"Mnemonic": "NPOR",
"CurveUnit": "{{datapartitionid}}:reference-data--UnitOfMeasure:m:",
"LogCurveFamilyID": "{{datapartitionid}}:reference-data--LogCurveFamily:NeutronPorosity:"
},
{
"CurveID": "Bulk Density",
"Mnemonic": "RHOB",
"CurveUnit": "{{datapartitionid}}:reference-data--UnitOfMeasure:m:",
"LogCurveFamilyID": "{{datapartitionid}}:reference-data--LogCurveFamily:BulkDensity:"
}
],
"WellboreId": "{{datapartitionid}}:master-data--Wellbore:{{wellboreId}}:",
"CreationDateTime": "2013-03-22T11:16:03Z",
"VerticalMeasurement": {
"VerticalMeasurement": 2680.5,
"VerticalMeasurementPathID": "{{datapartitionid}}:reference-data--VerticalMeasurementPath:MD:",
"VerticalMeasurementUnitOfMeasureID": "{{datapartitionid}}:reference-data--UnitOfMeasure:ft:"
},
"TopMeasuredDepth": 12345.6,
"BottomMeasuredDepth": 13856.25,
"Name": "{{welllogName}}",
"ExtensionProperties": {
"step": {
"unitKey": "ft",
"value": 0.1
},
"dateModified": "2013-03-22T11:16:03Z"
}
},
"id": "{{datapartitionid}}:work-product-component--WellLog:{{welllogId}}",
"kind": "osdu:wks:work-product-component--WellLog:1.0.0",
"legal": {
"legaltags": [
"{{legaltags}}"
],
"otherRelevantDataCountries": [
"US",
"FR"
]
},
"meta": [
{
"kind": "Unit",
"name": "ft",
"persistableReference": "{\"scaleOffset\":{\"scale\":0.3048,\"offset\":0.0},\"symbol\":\"ft\",\"baseMeasurement\":{\"ancestry\":\"Length\",\"type\":\"UM\"},\"type\":\"USO\"}",
"propertyNames": [
"stop.value",
"elevationReference.elevationFromMsl.value",
"start.value",
"step.value",
"reference.unitKey"
],
"propertyValues": [
"ft"
]
},
{
"kind": "DateTime",
"name": "datetime",
"persistableReference": "{\"format\":\"yyyy-MM-ddTHH:mm:ssZ\",\"timeZone\":\"UTC\",\"type\":\"DTM\"}",
"propertyNames": [
"dateModified",
"dateCreated"
]
}
]
}
]The schema identification for the OSDU resource object following the pattern {Namespace}:{Source}:{Type}:{VersionMajor}.{VersionMinor}.{VersionPatch}. The versioning scheme follows the semantic versioning, https://semver.org/.
Possible values: Value must match regular expression
^[\w\-\.]+:[\w\-\.]+:[\w\-\.]+:[0-9]+.[0-9]+.[0-9]+$Example:
osdu:wks:work-product-component--WellLog:1.0.0The access control tags associated with this entity.
- acl
The list of owners of this data record formatted as an email (core.common.model.storage.validation.ValidationDoc.EMAIL_REGEX).
Possible values: Value must match regular expression
^[a-zA-Z0-9_+&*-]+(?:\.[a-zA-Z0-9_+&*-]+)*@(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]{2,7}$The list of viewers to which this data record is accessible/visible/discoverable formatted as an email (core.common.model.storage.validation.ValidationDoc.EMAIL_REGEX).
Possible values: Value must match regular expression
^[a-zA-Z0-9_+&*-]+(?:\.[a-zA-Z0-9_+&*-]+)*@(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]{2,7}$
The entity's legal tags and compliance status. The actual contents associated with the legal tags is managed by the Compliance Service.
- legal
The list of legal tags, which resolve to legal properties (like country of origin, export classification code, etc.) and rules with the help of the Compliance Service.
The list of other relevant data countries as an array of two-letter country codes, see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.
Possible values: Value must match regular expression
^[A-Z]{2}$The legal status. Set by the system after evaluation against the compliance rules associated with the "legaltags" using the Compliance Service.
Possible values: Value must match regular expression
^(compliant|uncompliant)$
Previously called ResourceID or SRN which identifies this OSDU resource object without version.
Possible values: Value must match regular expression
^[\w\-\.]+:work-product-component\-\-WellLog:[\w\-\.\:\%]+$Example:
namespace:work-product-component--WellLog:c2c79f1c-90ca-5c92-b8df-04dbe438f414The version number of this OSDU resource; set by the framework.
Example:
1562066009929332A generic dictionary of string keys mapping to string value. Only strings are permitted as keys and values.
Examples:{ "NameOfKey": "String value" }- tags
Timestamp of the time at which initial version of this OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:46:20.163ZThe user reference, which created the first version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comTimestamp of the time at which this version of the OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:52:24.477ZThe user reference, which created this version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comThe links to data, which constitute the inputs.
- ancestry
An array of none, one or many entity references in the data ecosystem, which identify the source of data in the legal sense. In contract to other relationships, the source record version is required. Example: the 'parents' will be queried when e.g. the subscription of source data services is terminated; access to the derivatives is also terminated.
Possible values: Value must match regular expression
^[\w\-\.]+:[\w\-\.]+:[\w\-\.\:\%]+:[0-9]+$Example:
[]
The Frame of Reference meta data section linking the named properties to self-contained definitions.
Common resources to be injected at root 'data' level for every entity, which is persistable in Storage. The insertion is performed by the OsduSchemaComposer script.
Response
model of session exposed
identifier of the current session.
identifier of the record of which the session is attached to.
record version on top of which the session is based.
merge mode at commit. If 'update', existing data will be merged with the data sent during the session. If 'overrride', existing data will be ignored, the final result will only contains data sent within the session.
Possible values: [
overwrite,update]If the session is not committed before this dead line, session is automatically abandoned.
creation date
updated date
An enumeration.
Possible values: [
open,committing,abandoning,committed,abandoned]miscellaneous metadata associated to the session. The session creator can set some data here.
- meta
Status Code
Successful Response
Validation Error
No Sample Response
Create a new session on the given record for writing bulk data.
Initiate a session based on record version provided. The session is isolated from any other modifications. Inside a session, individual chunk doesn't generate new individual version. A new single version is created only at session completion 'aggregating' all updates. A typical workflow is:
- create a session
- send X chunks (can be parallelized)
- commit the session
Session has an expiry time. If the session is not completed before, it's automatically dropped. The session duration is specified in the request but cannot exceeds 24 hours.
POST /ddms/v3/welllogs/{record_id}/sessionsRequest
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
Note: if fromVersion is provided, should we: force mode to 'update' raise an error if mode is overwrite
merge mode at commit. If 'update', existing data will be merged with the data sent during the session. If 'overwrite', existing data will be ignored, the final result will only contains data sent within the session.
Allowable values: [
overwrite,update]specify the version on top of which update will be applied. By default use the latest one (0). Not relevant if overwrite is set to True.
Default:
0optional - time to live in minutes.
Default:
1440dictionary all values, stored in the session
- meta
Response
model of session exposed
identifier of the current session.
identifier of the record of which the session is attached to.
record version on top of which the session is based.
merge mode at commit. If 'update', existing data will be merged with the data sent during the session. If 'overrride', existing data will be ignored, the final result will only contains data sent within the session.
Possible values: [
overwrite,update]If the session is not committed before this dead line, session is automatically abandoned.
creation date
updated date
An enumeration.
Possible values: [
open,committing,abandoning,committed,abandoned]miscellaneous metadata associated to the session. The session creator can set some data here.
- meta
Status Code
Successful Response
Validation Error
{ "id": "xx1234", "recordId": "opendes:log:991234", "fromVersion": 25686567113, "mode": "update", "createdTime": "2021-03-07T15:49:01+00:00", "updatedTime": "2021-03-07T15:58:01+00:00", "expiry": "2021-03-08T15:49:01+00:00", "state": "open", "meta": { "creatorCustom": "someValue" } }
Get a specific session for a specific record.
GET /ddms/v3/welllogs/{record_id}/sessions/{session_id}Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
Response
model of session exposed
identifier of the current session.
identifier of the record of which the session is attached to.
record version on top of which the session is based.
merge mode at commit. If 'update', existing data will be merged with the data sent during the session. If 'overrride', existing data will be ignored, the final result will only contains data sent within the session.
Possible values: [
overwrite,update]If the session is not committed before this dead line, session is automatically abandoned.
creation date
updated date
An enumeration.
Possible values: [
open,committing,abandoning,committed,abandoned]miscellaneous metadata associated to the session. The session creator can set some data here.
- meta
Status Code
Successful Response
Validation Error
{ "id": "xx1234", "recordId": "opendes:log:991234", "fromVersion": 25686567113, "mode": "update", "createdTime": "2021-03-07T15:49:01+00:00", "updatedTime": "2021-03-07T15:58:01+00:00", "expiry": "2021-03-08T15:49:01+00:00", "state": "open", "meta": { "creatorCustom": "someValue" } }
Update a session, either commit or abandon.
PATCH /ddms/v3/welllogs/{record_id}/sessions/{session_id}Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
commitorabandona sessionAllowable values: [
commit,abandon]
Response
model of session exposed
identifier of the current session.
identifier of the record of which the session is attached to.
record version on top of which the session is based.
merge mode at commit. If 'update', existing data will be merged with the data sent during the session. If 'overrride', existing data will be ignored, the final result will only contains data sent within the session.
Possible values: [
overwrite,update]If the session is not committed before this dead line, session is automatically abandoned.
creation date
updated date
An enumeration.
Possible values: [
open,committing,abandoning,committed,abandoned]miscellaneous metadata associated to the session. The session creator can set some data here.
- meta
Status Code
Successful Response
Validation Error
{ "id": "xx1234", "recordId": "opendes:log:991234", "fromVersion": 25686567113, "mode": "update", "createdTime": "2021-03-07T15:49:01+00:00", "updatedTime": "2021-03-07T15:58:01+00:00", "expiry": "2021-03-08T15:49:01+00:00", "state": "open", "meta": { "creatorCustom": "someValue" } }
Send a data chunk. Session must be complete/commit once all chunks are sent.
Send a data chunk. Session must be complete/commit once all chunks are sent. This will create a new and single version aggregating all and previous bulk.Support JSON and Parquet format ('Content_Type' must be set accordingly). In case of JSON the orient must be set accordingly. Support http chunked encoding.
Required roles: 'users.datalake.editors' or 'users.datalake.admins'.
POST /ddms/v3/welllogs/{record_id}/sessions/{session_id}/dataRequest
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Allowable values: [
application/json,application/x-parquet]
Path Parameters
Query Parameters
format for JSON only.
Allowable values: [
split,columns]Default:
split
Contains the data corresponding to the dataframe. The header "Content-Type" must be set accordingly to the format sent:
Parquet format(application/x-parquet): see Apache parquet website.
JSON format (application/json): see Pandas.Dataframe JSON format.
In that case 'orient' parameter must be provided
.
Examples in JSON for data with 5 rows and 3 columns with different orient:
- split:
{"columns":["Ref","col_1","col_2"],"index":[0,1,2,3,4],"data":[[0.0,1111.1,2222.1],[0.5,1111.2,2222.2],[1.0,1111.3,2222.3],[1.5,1111.4,2222.4],[2.0,1111.5,2222.5]]}
- columns:
{"Ref":{"0":0.0,"1":0.5,"2":1.0,"3":1.5,"4":2.0},"col_1":{"0":1111.1,"1":1111.2,"2":1111.3,"3":1111.4,"4":1111.5},"col_2":{"0":2222.1,"1":2222.2,"2":2222.3,"3":2222.4,"4":2222.5}}
{
"columns":[
"Ref",
"col_1",
"col_2"
],
"index":[
0,
1,
2,
3,
4
],
"data":[
[
0.0,
1111.1,
2222.1
],
[
0.5,
1111.2,
2222.2
],
[
1.0,
1111.3,
2222.3
],
[
1.5,
1111.4,
2222.4
],
[
2.0,
1111.5,
2222.5
]
]
}Get the WellboreTrajectory by using identifier
Get the WellboreTrajectory object using its id.
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. "In addition, users must be a member of data groups to access the data.
GET /ddms/v3/wellboretrajectories/{wellboretrajectoryid}Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
Response
Work Product Component describing an individual instance of a wellbore trajectory data object. Also called a deviation survey, wellbore trajectory is data that is used to calculate the position and spatial uncertainty of a planned or actual wellbore in 2-dimensional and 3-dimensional space.
The schema identification for the OSDU resource object following the pattern {Namespace}:{Source}:{Type}:{VersionMajor}.{VersionMinor}.{VersionPatch}. The versioning scheme follows the semantic versioning, https://semver.org/.
Possible values: Value must match regular expression
^[\w\-\.]+:[\w\-\.]+:[\w\-\.]+:[0-9]+.[0-9]+.[0-9]+$Example:
osdu:wks:work-product-component--WellboreTrajectory:1.1.0The access control tags associated with this entity.
- acl
The list of owners of this data record formatted as an email (core.common.model.storage.validation.ValidationDoc.EMAIL_REGEX).
Possible values: Value must match regular expression
^[a-zA-Z0-9_+&*-]+(?:\.[a-zA-Z0-9_+&*-]+)*@(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]{2,7}$The list of viewers to which this data record is accessible/visible/discoverable formatted as an email (core.common.model.storage.validation.ValidationDoc.EMAIL_REGEX).
Possible values: Value must match regular expression
^[a-zA-Z0-9_+&*-]+(?:\.[a-zA-Z0-9_+&*-]+)*@(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]{2,7}$
The entity's legal tags and compliance status. The actual contents associated with the legal tags is managed by the Compliance Service.
- legal
The list of legal tags, which resolve to legal properties (like country of origin, export classification code, etc.) and rules with the help of the Compliance Service.
The list of other relevant data countries as an array of two-letter country codes, see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.
Possible values: Value must match regular expression
^[A-Z]{2}$The legal status. Set by the system after evaluation against the compliance rules associated with the "legaltags" using the Compliance Service.
Possible values: Value must match regular expression
^(compliant|uncompliant)$
Previously called ResourceID or SRN which identifies this OSDU resource object without version.
Possible values: Value must match regular expression
^[\w\-\.]+:work-product-component\-\-WellboreTrajectory:[\w\-\.\:\%]+$Example:
namespace:work-product-component--WellboreTrajectory:606f224a-ef1f-5690-9843-d26cd7e33e10The version number of this OSDU resource; set by the framework.
Example:
1562066009929332A generic dictionary of string keys mapping to string value. Only strings are permitted as keys and values.
Examples:{ "NameOfKey": "String value" }- tags
Timestamp of the time at which initial version of this OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:46:20.163ZThe user reference, which created the first version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comTimestamp of the time at which this version of the OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:52:24.477ZThe user reference, which created this version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comThe links to data, which constitute the inputs.
- ancestry
An array of none, one or many entity references in the data ecosystem, which identify the source of data in the legal sense. In contract to other relationships, the source record version is required. Example: the 'parents' will be queried when e.g. the subscription of source data services is terminated; access to the derivatives is also terminated.
Possible values: Value must match regular expression
^[\w\-\.]+:[\w\-\.]+:[\w\-\.\:\%]+:[0-9]+$Example:
[]
The Frame of Reference meta data section linking the named properties to self-contained definitions.
Common resources to be injected at root 'data' level for every entity, which is persistable in Storage. The insertion is performed by the OsduSchemaComposer script.
Status Code
Successful Response
Wellbore Trajectory not found
Validation Error
No Sample Response
Delete the wellboreTrajectory. The API performs a logical deletion of the given record. No recursive delete for OSDU kinds
Required roles: 'users.datalake.editors' or 'users.datalake.admins'.
DELETE /ddms/v3/wellboretrajectories/{wellboretrajectoryid}Get all versions of the WellboreTrajectory
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. "In addition, users must be a member of data groups to access the data.
GET /ddms/v3/wellboretrajectories/{wellboretrajectoryid}/versionsGet the given version of the WellboreTrajectory using OSDU wellboreTrajectory schema
"Get the WellboreTrajectory object using its id.
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. "In addition, users must be a member of data groups to access the data.
GET /ddms/v3/wellboretrajectories/{wellboretrajectoryid}/versions/{version}Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
Response
Work Product Component describing an individual instance of a wellbore trajectory data object. Also called a deviation survey, wellbore trajectory is data that is used to calculate the position and spatial uncertainty of a planned or actual wellbore in 2-dimensional and 3-dimensional space.
The schema identification for the OSDU resource object following the pattern {Namespace}:{Source}:{Type}:{VersionMajor}.{VersionMinor}.{VersionPatch}. The versioning scheme follows the semantic versioning, https://semver.org/.
Possible values: Value must match regular expression
^[\w\-\.]+:[\w\-\.]+:[\w\-\.]+:[0-9]+.[0-9]+.[0-9]+$Example:
osdu:wks:work-product-component--WellboreTrajectory:1.1.0The access control tags associated with this entity.
- acl
The list of owners of this data record formatted as an email (core.common.model.storage.validation.ValidationDoc.EMAIL_REGEX).
Possible values: Value must match regular expression
^[a-zA-Z0-9_+&*-]+(?:\.[a-zA-Z0-9_+&*-]+)*@(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]{2,7}$The list of viewers to which this data record is accessible/visible/discoverable formatted as an email (core.common.model.storage.validation.ValidationDoc.EMAIL_REGEX).
Possible values: Value must match regular expression
^[a-zA-Z0-9_+&*-]+(?:\.[a-zA-Z0-9_+&*-]+)*@(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]{2,7}$
The entity's legal tags and compliance status. The actual contents associated with the legal tags is managed by the Compliance Service.
- legal
The list of legal tags, which resolve to legal properties (like country of origin, export classification code, etc.) and rules with the help of the Compliance Service.
The list of other relevant data countries as an array of two-letter country codes, see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.
Possible values: Value must match regular expression
^[A-Z]{2}$The legal status. Set by the system after evaluation against the compliance rules associated with the "legaltags" using the Compliance Service.
Possible values: Value must match regular expression
^(compliant|uncompliant)$
Previously called ResourceID or SRN which identifies this OSDU resource object without version.
Possible values: Value must match regular expression
^[\w\-\.]+:work-product-component\-\-WellboreTrajectory:[\w\-\.\:\%]+$Example:
namespace:work-product-component--WellboreTrajectory:606f224a-ef1f-5690-9843-d26cd7e33e10The version number of this OSDU resource; set by the framework.
Example:
1562066009929332A generic dictionary of string keys mapping to string value. Only strings are permitted as keys and values.
Examples:{ "NameOfKey": "String value" }- tags
Timestamp of the time at which initial version of this OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:46:20.163ZThe user reference, which created the first version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comTimestamp of the time at which this version of the OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:52:24.477ZThe user reference, which created this version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comThe links to data, which constitute the inputs.
- ancestry
An array of none, one or many entity references in the data ecosystem, which identify the source of data in the legal sense. In contract to other relationships, the source record version is required. Example: the 'parents' will be queried when e.g. the subscription of source data services is terminated; access to the derivatives is also terminated.
Possible values: Value must match regular expression
^[\w\-\.]+:[\w\-\.]+:[\w\-\.\:\%]+:[0-9]+$Example:
[]
The Frame of Reference meta data section linking the named properties to self-contained definitions.
Common resources to be injected at root 'data' level for every entity, which is persistable in Storage. The insertion is performed by the OsduSchemaComposer script.
Status Code
Successful Response
WellboreTrajectory not found
Validation Error
No Sample Response
Create or update the WellboreTrajectories
Required roles: 'users.datalake.editors' or 'users.datalake.admins'.
POST /ddms/v3/wellboretrajectories
Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Work Product Component describing an individual instance of a wellbore trajectory data object. Also called a deviation survey, wellbore trajectory is data that is used to calculate the position and spatial uncertainty of a planned or actual wellbore in 2-dimensional and 3-dimensional space.
The schema identification for the OSDU resource object following the pattern {Namespace}:{Source}:{Type}:{VersionMajor}.{VersionMinor}.{VersionPatch}. The versioning scheme follows the semantic versioning, https://semver.org/.
Possible values: Value must match regular expression
^[\w\-\.]+:[\w\-\.]+:[\w\-\.]+:[0-9]+.[0-9]+.[0-9]+$Example:
osdu:wks:work-product-component--WellboreTrajectory:1.1.0The access control tags associated with this entity.
- acl
The list of owners of this data record formatted as an email (core.common.model.storage.validation.ValidationDoc.EMAIL_REGEX).
Possible values: Value must match regular expression
^[a-zA-Z0-9_+&*-]+(?:\.[a-zA-Z0-9_+&*-]+)*@(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]{2,7}$The list of viewers to which this data record is accessible/visible/discoverable formatted as an email (core.common.model.storage.validation.ValidationDoc.EMAIL_REGEX).
Possible values: Value must match regular expression
^[a-zA-Z0-9_+&*-]+(?:\.[a-zA-Z0-9_+&*-]+)*@(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]{2,7}$
The entity's legal tags and compliance status. The actual contents associated with the legal tags is managed by the Compliance Service.
- legal
The list of legal tags, which resolve to legal properties (like country of origin, export classification code, etc.) and rules with the help of the Compliance Service.
The list of other relevant data countries as an array of two-letter country codes, see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.
Possible values: Value must match regular expression
^[A-Z]{2}$The legal status. Set by the system after evaluation against the compliance rules associated with the "legaltags" using the Compliance Service.
Possible values: Value must match regular expression
^(compliant|uncompliant)$
Previously called ResourceID or SRN which identifies this OSDU resource object without version.
Possible values: Value must match regular expression
^[\w\-\.]+:work-product-component\-\-WellboreTrajectory:[\w\-\.\:\%]+$Example:
namespace:work-product-component--WellboreTrajectory:606f224a-ef1f-5690-9843-d26cd7e33e10The version number of this OSDU resource; set by the framework.
Example:
1562066009929332A generic dictionary of string keys mapping to string value. Only strings are permitted as keys and values.
Examples:{ "NameOfKey": "String value" }- tags
Timestamp of the time at which initial version of this OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:46:20.163ZThe user reference, which created the first version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comTimestamp of the time at which this version of the OSDU resource object was created. Set by the System. The value is a combined date-time string in ISO-8601 given in UTC.
Example:
2020-12-16T11:52:24.477ZThe user reference, which created this version of this resource object. Set by the System.
Example:
some-user@some-company-cloud.comThe links to data, which constitute the inputs.
- ancestry
An array of none, one or many entity references in the data ecosystem, which identify the source of data in the legal sense. In contract to other relationships, the source record version is required. Example: the 'parents' will be queried when e.g. the subscription of source data services is terminated; access to the derivatives is also terminated.
Possible values: Value must match regular expression
^[\w\-\.]+:[\w\-\.]+:[\w\-\.\:\%]+:[0-9]+$Example:
[]
The Frame of Reference meta data section linking the named properties to self-contained definitions.
Common resources to be injected at root 'data' level for every entity, which is persistable in Storage. The insertion is performed by the OsduSchemaComposer script.
Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
Response
model of session exposed
identifier of the current session.
identifier of the record of which the session is attached to.
record version on top of which the session is based.
merge mode at commit. If 'update', existing data will be merged with the data sent during the session. If 'overrride', existing data will be ignored, the final result will only contains data sent within the session.
Possible values: [
overwrite,update]If the session is not committed before this dead line, session is automatically abandoned.
creation date
updated date
An enumeration.
Possible values: [
open,committing,abandoning,committed,abandoned]miscellaneous metadata associated to the session. The session creator can set some data here.
- meta
Status Code
Successful Response
Validation Error
No Sample Response
Create a new session for the record for writing bulk data.
Initiate a session based on record version provided. The session is isolated from any other modifications. Inside a session, individual chunk doesn't generate new individual version. A new single version is created only at session completion 'aggregating' all updates. A typical workflow is:
- create a session
- send X chunks (can be parallelized)
- commit the session
Session has an expiry time. If the session is not completed before, it's automatically dropped. The session duration is specified in the request but cannot exceeds 24 hours.
POST /ddms/v3/wellboretrajectories/{record_id}/sessionsRequest
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
Note: if fromVersion is provided, should we: force mode to 'update' raise an error if mode is overwrite
merge mode at commit. If 'update', existing data will be merged with the data sent during the session. If 'overwrite', existing data will be ignored, the final result will only contains data sent within the session.
Allowable values: [
overwrite,update]specify the version on top of which update will be applied. By default use the latest one (0). Not relevant if overwrite is set to True.
Default:
0optional - time to live in minutes.
Default:
1440dictionary all values, stored in the session
- meta
Response
model of session exposed
identifier of the current session.
identifier of the record of which the session is attached to.
record version on top of which the session is based.
merge mode at commit. If 'update', existing data will be merged with the data sent during the session. If 'overrride', existing data will be ignored, the final result will only contains data sent within the session.
Possible values: [
overwrite,update]If the session is not committed before this dead line, session is automatically abandoned.
creation date
updated date
An enumeration.
Possible values: [
open,committing,abandoning,committed,abandoned]miscellaneous metadata associated to the session. The session creator can set some data here.
- meta
Status Code
Successful Response
Validation Error
{ "id": "xx1234", "recordId": "opendes:log:991234", "fromVersion": 25686567113, "mode": "update", "createdTime": "2021-03-07T15:49:01+00:00", "updatedTime": "2021-03-07T15:58:01+00:00", "expiry": "2021-03-08T15:49:01+00:00", "state": "open", "meta": { "creatorCustom": "someValue" } }
Get a specific session for a specific record.
GET /ddms/v3/wellboretrajectories/{record_id}/sessions/{session_id}Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
Response
model of session exposed
identifier of the current session.
identifier of the record of which the session is attached to.
record version on top of which the session is based.
merge mode at commit. If 'update', existing data will be merged with the data sent during the session. If 'overrride', existing data will be ignored, the final result will only contains data sent within the session.
Possible values: [
overwrite,update]If the session is not committed before this dead line, session is automatically abandoned.
creation date
updated date
An enumeration.
Possible values: [
open,committing,abandoning,committed,abandoned]miscellaneous metadata associated to the session. The session creator can set some data here.
- meta
Status Code
Successful Response
Validation Error
{ "id": "xx1234", "recordId": "opendes:log:991234", "fromVersion": 25686567113, "mode": "update", "createdTime": "2021-03-07T15:49:01+00:00", "updatedTime": "2021-03-07T15:58:01+00:00", "expiry": "2021-03-08T15:49:01+00:00", "state": "open", "meta": { "creatorCustom": "someValue" } }
Update a session, either commit or abandon.
PATCH /ddms/v3/wellboretrajectories/{record_id}/sessions/{session_id}Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Path Parameters
commitorabandona sessionAllowable values: [
commit,abandon]
Response
model of session exposed
identifier of the current session.
identifier of the record of which the session is attached to.
record version on top of which the session is based.
merge mode at commit. If 'update', existing data will be merged with the data sent during the session. If 'overrride', existing data will be ignored, the final result will only contains data sent within the session.
Possible values: [
overwrite,update]If the session is not committed before this dead line, session is automatically abandoned.
creation date
updated date
An enumeration.
Possible values: [
open,committing,abandoning,committed,abandoned]miscellaneous metadata associated to the session. The session creator can set some data here.
- meta
Status Code
Successful Response
Validation Error
{ "id": "xx1234", "recordId": "opendes:log:991234", "fromVersion": 25686567113, "mode": "update", "createdTime": "2021-03-07T15:49:01+00:00", "updatedTime": "2021-03-07T15:58:01+00:00", "expiry": "2021-03-08T15:49:01+00:00", "state": "open", "meta": { "creatorCustom": "someValue" } }
Returns the data according to the specified query parameters.
Returns the data according to the specified query parameters. Multiple media types response are available ("application/json", text/csv", "application/x-parquet"). The desired format can be specify in "Accept" header. The default is Parquet. When bulk statistics are requested using "describe" parameter, the response is always provided in JSON.
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. "In addition, users must be a member of data groups to access the data.
GET /ddms/v3/wellboretrajectories/{record_id}/dataRequest
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Allowable values: [
application/json,application/x-parquet,text/csv]
Path Parameters
Query Parameters
The number of rows that are to be skipped and not included in the result.
Possible values: value ≥ 0
Example:
5The maximum number of rows to be returned.
Possible values: value ≥ 1
Example:
100Filters curves. List of curves to be returned. The curves are returned in the same order as it is given.
Example:
MD,GRThe "describe" query option allows clients to request a description of the matching result. (number of rows, columns name)
Default:
falseExample:
falseformat for JSON only.
Allowable values: [
split,columns]Default:
split
Writes data as a whole bulk, creates a new version.
Writes data to the associated record. It creates a new version. Payload is expected to contain the entire bulk which will replace as latest version any previous bulk. Previous bulk versions are accessible via the get bulk data version API. Support JSON and Parquet format ('Content_Type' must be set accordingly). In case of JSON the orient must be set accordingly. Support http chunked encoding transfer.
Required roles: 'users.datalake.editors' or 'users.datalake.admins'.
POST /ddms/v3/wellboretrajectories/{record_id}/dataRequest
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Allowable values: [
application/json,application/x-parquet]
Path Parameters
Query Parameters
format for JSON only.
Allowable values: [
split,columns]Default:
split
Contains the data corresponding to the dataframe. The header "Content-Type" must be set accordingly to the format sent:
Parquet format(application/x-parquet): see Apache parquet website.
JSON format (application/json): see Pandas.Dataframe JSON format.
In that case 'orient' parameter must be provided
.
Examples in JSON for data with 5 rows and 3 columns with different orient:
- split:
{"columns":["Ref","col_1","col_2"],"index":[0,1,2,3,4],"data":[[0.0,1111.1,2222.1],[0.5,1111.2,2222.2],[1.0,1111.3,2222.3],[1.5,1111.4,2222.4],[2.0,1111.5,2222.5]]}
- columns:
{"Ref":{"0":0.0,"1":0.5,"2":1.0,"3":1.5,"4":2.0},"col_1":{"0":1111.1,"1":1111.2,"2":1111.3,"3":1111.4,"4":1111.5},"col_2":{"0":2222.1,"1":2222.2,"2":2222.3,"3":2222.4,"4":2222.5}}
{
"columns":[
"Ref",
"col_1",
"col_2"
],
"index":[
0,
1,
2,
3,
4
],
"data":[
[
0.0,
1111.1,
2222.1
],
[
0.5,
1111.2,
2222.2
],
[
1.0,
1111.3,
2222.3
],
[
1.5,
1111.4,
2222.4
],
[
2.0,
1111.5,
2222.5
]
]
}Send a data chunk. Session must be complete or committed once all chunks are sent.
Send a data chunk. Session must be complete/commit once all chunks are sent. This will create a new and single version aggregating all and previous bulk.Support JSON and Parquet format ('Content_Type' must be set accordingly). In case of JSON the orient must be set accordingly. Support http chunked encoding.
Required roles: 'users.datalake.editors' or 'users.datalake.admins'.
POST /ddms/v3/wellboretrajectories/{record_id}/sessions/{session_id}/dataRequest
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Allowable values: [
application/json,application/x-parquet]
Path Parameters
Query Parameters
format for JSON only.
Allowable values: [
split,columns]Default:
split
Contains the data corresponding to the dataframe. The header "Content-Type" must be set accordingly to the format sent:
Parquet format(application/x-parquet): see Apache parquet website.
JSON format (application/json): see Pandas.Dataframe JSON format.
In that case 'orient' parameter must be provided
.
Examples in JSON for data with 5 rows and 3 columns with different orient:
- split:
{"columns":["Ref","col_1","col_2"],"index":[0,1,2,3,4],"data":[[0.0,1111.1,2222.1],[0.5,1111.2,2222.2],[1.0,1111.3,2222.3],[1.5,1111.4,2222.4],[2.0,1111.5,2222.5]]}
- columns:
{"Ref":{"0":0.0,"1":0.5,"2":1.0,"3":1.5,"4":2.0},"col_1":{"0":1111.1,"1":1111.2,"2":1111.3,"3":1111.4,"4":1111.5},"col_2":{"0":2222.1,"1":2222.2,"2":2222.3,"3":2222.4,"4":2222.5}}
{
"columns":[
"Ref",
"col_1",
"col_2"
],
"index":[
0,
1,
2,
3,
4
],
"data":[
[
0.0,
1111.1,
2222.1
],
[
0.5,
1111.2,
2222.2
],
[
1.0,
1111.3,
2222.3
],
[
1.5,
1111.4,
2222.4
],
[
2.0,
1111.5,
2222.5
]
]
}Returns data of the specified version.
Returns the data of a specific version according to the specified query parameters. Multiple media types response are available ("application/json", text/csv", "application/x-parquet") The desired format can be specify in "Accept" header. The default is Parquet. When bulk statistics are requested using "describe" parameter, the response is always provided in JSON
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. "In addition, users must be a member of data groups to access the data.
GET /ddms/v3/wellboretrajectories/{record_id}/versions/{version}/dataRequest
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
Allowable values: [
application/json,application/x-parquet,text/csv]
Path Parameters
Query Parameters
The number of rows that are to be skipped and not included in the result.
Possible values: value ≥ 0
Example:
5The maximum number of rows to be returned.
Possible values: value ≥ 1
Example:
100Filters curves. List of curves to be returned. The curves are returned in the same order as it is given.
Example:
MD,GRThe "describe" query option allows clients to request a description of the matching result. (number of rows, columns name)
Default:
falseExample:
falseformat for JSON only.
Allowable values: [
split,columns]Default:
split
Query
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
POST /ddms/query
Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
''kind'' to search
The maximum number of results to return from the given offset. If no limit is provided, then it will return 10 items. Max number of items which can be fetched by the query is 100. (If you wish to fetch large set of items, please use query_with_cursor API)
The starting offset from which to return results.
The query string in Lucene query string syntax.
The queryAsOwner switches between viewer and owner to return results that you are entitled to view or results you are the owner of.
The fields on which to project the results.
Query with cursor
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
POST /ddms/query_with_cursor
Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
''kind'' to search
The maximum number of results to return from the given offset. If no limit is provided, then it will return 10 items. Max number of items which can be fetched by the query is 100. (If you wish to fetch large set of items, please use query_with_cursor API)
The starting offset from which to return results.
The query string in Lucene query string syntax.
The queryAsOwner switches between viewer and owner to return results that you are entitled to view or results you are the owner of.
The fields on which to project the results.
Query with cursor
Get all Wellbores object. The wellbore kind is :wks:wellbore:. It returns all records directly based on existing schemas. Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
POST /ddms/query/wellbores
Query with cursor in CRS format: data.wellHeadWgs84
Get all Wellbores object in a specific area. The specific area will be define by a circle based on its center coordinates (lat, lon) and radius (meters) The wellbore kind is ":wks:wellbore:" and it returns all records directly based on existing schemas. Required roles are "users.datalake.viewers" or "users.datalake.editors" or "users.datala.admins". In addition, users must be a member of data groups to access the data.
POST /ddms/query/wellbores/bydistance
Query with cursor in CRS format: data.wellHeadWgs84
Get all Wellbores object in a specific area.
The specific area will be define by a square based on its top left coordinates (lat, lon) and its bottom right coordinates (log, lat)
The wellbore kind is :wks:wellbore: returns all records directly based on existing schemas
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
POST /ddms/query/wellbores/byboundingbox
Query with cursor in CRS format: data.wellHeadWgs84
Get all Wellbores object in a specific area.
The specific area will be define by a polygon based on each of its coordinates (lat, lon) with a minimum of three
The wellbore kind is :wks:wellbore: returns all records directly based on existing schemas
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
POST /ddms/query/wellbores/bygeopolygon
Query with cursor, search logSets by wellbore ID
Get all LogSets object using its relationship Wellbore ID.
All LogSets linked to this specific ID will be returned
The LogSet kind is :wks:logSet: returns all records directly based on existing schemas
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
POST /ddms/query/wellbore/{wellboreId}/logsetsQuery with cursor, search logSets by wellbore attribute
Get all LogSets object using a specific attribute of Wellbores.
All LogSets linked to Wellbores with this specific attribute will be returned
The LogSet kind is :wks:logSet: returns all records directly based on existing schemas
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
POST /ddms/query/wellbores/{wellboreAttribute}/logsetsQuery with cursor, gets logs
Get all Logs object.
The Logs kind is :wks:log: returns all records directly based on existing schemas
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
POST /ddms/query/logs
Query with cursor, search logs by wellbore ID
Get all Logs object using its relationship Wellbore ID.
All Logs linked to this specific ID will be returned
The Log kind is :wks:log: returns all records directly based on existing schemas
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
POST /ddms/query/wellbore/{wellboreId}/logsQuery with cursor, search logs by wellbore attribute
Get all Logs object using a specific attribute of Wellbores.
All Logs linked to Wellbores with this specific attribute will be returned
The Log kind is :wks:log: returns all records directly based on existing schemas
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
POST /ddms/query/wellbores/{wellboreAttribute}/logsQuery with cursor, search logs by logSet ID
Get all Logs object using its relationship Logset ID.
All Logs linked to this specific ID will be returned
The Log kind is :wks:log: returns all records directly based on existing schemas
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
POST /ddms/query/logset/{logsetId}/logsQuery with cursor, search logs by logSet attribute
Get all Logs object using a specific attribute of LogSets.
All Logs linked to LogSets with this specific attribute will be returned
The Log kind is :wks:log: returns all records directly based on existing schemas
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
POST /ddms/query/logsets/{logsetAttribute}/logsQuery with cursor, search markers by wellbore ID
Get all Markers object using its relationship Wellbore ID.
All Markers linked to this specific ID will be returned
The Marker kind is :wks:marker: returns all records directly based on existing schemas
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
POST /ddms/query/wellbore/{wellboreId}/markersQuery with a cursor
Get all Wellbores IDs object.
The wellbore kind is :wks:wellbore: returns all records IDs IDs directly based on existing schemas
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
POST /ddms/fastquery/wellbores
Query with a cursor in CRS format: data.wellHeadWgs84
Get all Wellbores IDs IDs objects in a specific area.
The specific area will be define by a circle based on its center coordinates (lat, lon) and radius (meters)
The wellbore kind is :wks:wellbore: returns all records IDs IDs directly based on existing schemas
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
POST /ddms/fastquery/wellbores/bydistance
Query with a cursor in CRS format: data.wellHeadWgs84
Get all Wellbores IDs objects in a specific area.
The specific area will be define by a square based on its top left coordinates (lat, lon) and its bottom right coordinates (log, lat)
The wellbore kind is :wks:wellbore: returns all records IDs directly based on existing schemas
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
POST /ddms/fastquery/wellbores/byboundingbox
Query with a cursor in CRS format: data.wellHeadWgs84
Get all Wellbores IDs objects in a specific area.
The specific area will be define by a polygon based on each of its coordinates (lat, lon) with a minimum of three
The wellbore kind is :wks:wellbore: returns all records IDs directly based on existing schemas
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
POST /ddms/fastquery/wellbores/bygeopolygon
Query with a cursor. Search logSets IDs by wellbore ID
Get all LogSets IDs objects using its relationship Wellbore ID.
All LogSets linked to this specific ID will be returned
The LogSet kind is :wks:logSet: returns all records IDs directly based on existing schemas
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
POST /ddms/fastquery/wellbore/{wellbore_id}/logsetsQuery with a cursor. Search logSets IDs by wellbore attribute.
Get all LogSets IDs objects using a specific attribute of Wellbores.
All LogSets linked to Wellbores with this specific attribute will be returned
The LogSet kind is :wks:logSet: returns all records IDs directly based on existing schemas
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
POST /ddms/fastquery/wellbores/{wellbore_attribute}/logsetsQuery with cursor. Gets logs
Get all Logs object.
The Logs kind is :wks:log: returns all records IDs directly based on existing schemas
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
POST /ddms/fastquery/logs
Query with a cursor. Search logs IDs by wellbore ID
Get all Logs IDs objects using its relationship Wellbore ID.
All Logs linked to this specific ID will be returned
The Log kind is :wks:log: returns all records IDs directly based on existing schemas
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
POST /ddms/fastquery/wellbore/{wellbore_id}/logsQuery with a cursor. Search logs IDs by wellbore attribute
Get all Logs IDs objects using a specific attribute of Wellbores.
All Logs linked to Wellbores with this specific attribute will be returned
The Log kind is :wks:log: returns all records IDs directly based on existing schemas
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
POST /ddms/fastquery/wellbores/{wellbore_attribute}/logsQuery with a cursor. Search logs IDs by logSet ID.
Get all Logs IDs objects using its relationship Logset ID.
All Logs linked to this specific ID will be returned
The Log kind is :wks:log: returns all records IDs directly based on existing schemas
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
POST /ddms/fastquery/logset/{logset_id}/logsQuery with a cursor. Search logs IDs by logSet attribute
Get all Logs IDs objects using a specific attribute of LogSets.
All Logs linked to LogSets with this specific attribute will be returned
The Log kind is :wks:log: returns all records IDs directly based on existing schemas
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
POST /ddms/fastquery/logsets/{logset_attribute}/logsQuery with a cursor. Search markers IDs by wellbore ID
Get all Markers IDs objects using its relationship Wellbore ID.
All Markers linked to this specific ID will be returned
The Marker kind is :wks:marker: returns all records IDs directly based on existing schemas
Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data.
POST /ddms/fastquery/wellbore/{wellbore_id}/markersRecognize family and unit
Find the most probable family and unit using family assignment rule based catalogs. User defined catalog will have the priority.
POST /log-recognition/family
Upload user-defined catalog with family assignment rules
Upload user-defined catalog with family assignment rules for specific partition ID. If there is an existing catalog, it will be replaced. It takes maximum of 5 mins to replace the existing catalog. Hence, any call to retrieve the family should be made after 5 mins of uploading the catalog.
Required roles: 'users.datalake.editors' or 'users.datalake.admins'.
PUT /log-recognition/upload-catalog
Request
Custom Headers
identifier of the data partition to query
Possible values: length ≥ 1
{
"acl": {
"viewers": [
"abc@domain.com, cde@domain.com"
],
"owners": [
"abc@domain.com, cde@domain.com"
]
},
"legal": {
"legaltags": [
"opendes-public-usa-dataset-1"
],
"otherRelevantDataCountries": [
"US"
]
},
"data": {
"family_catalog": [
{
"unit": "ohm.m",
"family": "Medium Resistivity",
"rule": "MEDR"
}
],
"main_family_catalog": [
{
"MainFamily": "Resistivity",
"Family": "Medium Resistivity",
"Unit": "OHMM"
}
]
}
}Register a seismic-dms tenant
- Register a seismic-dms tenant in a data partition.
- Required roles: seistore.system.admin
POST /tenant/{tenantid}Request
Path Parameters
Name of the tenant
Request body
{
"gcpid": "google_project_id",
"esd": "slb.p4d.cloud.slb-ds.com",
"default_acl": "authgroup@data_partition.com"
}Google cloud project id associated with the tenant
Entitlements group sub domain. For instance, if the entitlements group is group-a.slb.env.cloud.com, the esd value is slb.env.cloud.com
Entitlements authorization group to manage tenant administrators
Register a new application
- Register a new application in seismic store.
- Required roles: users.datalake.admin
POST /app
Set a registered application as a trusted application
- Set a registered application as a trusted application in seismic store.
- Required roles: users.datalake.admin
POST /app/trusted
Retrieve the subproject metadata
- Return the metadata for a requested sub-project.
- Required roles: subproject.admin
GET /subproject/tenant/{tenantid}/subproject/{subprojectid}Response
Name of the subproject
Name of the tenant
Storage class for the bucket
Storage location for the bucket
Administrator for the subproject
Legal tag for the subproject
Cloud storage bucket associated with the subproject
ACLs with admin groups and viewere groups
- acls
Status Code
Retrieved subproject metadata successfully
Bad request
Unauthorized
Forbidden
Not found
{ "name": "spx01", "tenant": "tnx01", "storage_class": "MULTI_REGIONAL", "storage_location": "US", "admin": "test@email", "ltag": "Slb-Private-USA-EHC", "gcs_bucket": "subproject-bucket", "acls": { "admins": [ "service.seistore.p4d.tenant01.subproject01.admin@slb.p4d.cloud.slb-ds.com", "service.seistore.p4d.tenant01.subproject01.editor@slb.p4d.cloud.slb-ds.com" ], "viewers": [ "service.seistore.p4d.tenant01.subproject01.viewer@slb.p4d.cloud.slb-ds.com" ] } }
Create a new subproject
- Creates a new sub-project resource in seismic store.
- Required roles: users.datalake.admin
POST /subproject/tenant/{tenantid}/subproject/{subprojectid}Request
Custom Headers
Legal tag of the datapartition/tenant
Path Parameters
Name of the subproject
Name of the tenant
Request body
{
"admin": "test@email",
"storage_class": "MULTI_REGIONAL",
"storage_location": "US",
"acls": {
"admins": [
"service.seistore.p4d.tenant01.subproject01.admin@slb.p4d.cloud.slb-ds.com",
"service.seistore.p4d.tenant01.subproject01.editor@slb.p4d.cloud.slb-ds.com"
],
"viewers": [
"service.seistore.p4d.tenant01.subproject01.viewer@slb.p4d.cloud.slb-ds.com"
]
}
}Administrator for the subproject
Storage class for the bucket
Storage location for the bucket
ACLs with admin groups and viewere groups
- acls
Response
Name of the subproject
Name of the tenant
Storage class for the bucket
Storage location for the bucket
Administrator for the subproject
Legal tag for the subproject
Cloud storage bucket associated with the subproject
ACLs with admin groups and viewere groups
- acls
Status Code
Creation of the subproject is successful.
Bad request
Unauthorized
Forbidden
Not found
Conflict
{ "name": "spx01", "tenant": "tnx01", "storage_class": "MULTI_REGIONAL", "storage_location": "US", "admin": "test@email", "ltag": "Slb-Private-USA-EHC", "gcs_bucket": "subproject-bucket", "acls": { "admins": [ "service.seistore.p4d.tenant01.subproject01.admin@slb.p4d.cloud.slb-ds.com", "service.seistore.p4d.tenant01.subproject01.editor@slb.p4d.cloud.slb-ds.com" ], "viewers": [ "service.seistore.p4d.tenant01.subproject01.viewer@slb.p4d.cloud.slb-ds.com" ] } }
Patch a subproject metadata
- Patch a subproject metadata in seismic store.
- Required roles: subproject.admin
PATCH /subproject/tenant/{tenantid}/subproject/{subprojectid}Request
Custom Headers
Legal tag of the subproject
Path Parameters
Name of the tenant
Name of the subproject
Query Parameters
True if the legal tags of all datasets in a subproject needs to be updated
Response
Name of the subproject
Name of the tenant
Storage class for the bucket
Storage location for the bucket
Administrator for the subproject
Legal tag for the subproject
Cloud storage bucket associated with the subproject
ACLs with admin groups and viewere groups
- acls
Status Code
Updated subproject metadata successfully
Bad request
Unauthorized
Forbidden
Not found
{ "name": "spx01", "tenant": "tnx01", "storage_class": "MULTI_REGIONAL", "storage_location": "US", "admin": "test@email", "ltag": "Slb-Private-USA-EHC", "gcs_bucket": "subproject-bucket", "acls": { "admins": [ "service.seistore.p4d.tenant01.subproject01.admin@slb.p4d.cloud.slb-ds.com", "service.seistore.p4d.tenant01.subproject01.editor@slb.p4d.cloud.slb-ds.com" ], "viewers": [ "service.seistore.p4d.tenant01.subproject01.viewer@slb.p4d.cloud.slb-ds.com" ] } }
List subprojects in a tenant
- Return the list of sub-project in a tenant.
- Required roles: users.datalake.admin
GET /subproject/tenant/{tenantid}Response
Name of the subproject
Name of the tenant
Storage class for the bucket
Storage location for the bucket
Administrator for the subproject
Legal tag for the subproject
Cloud storage bucket associated with the subproject
ACLs with admin groups and viewere groups
- acls
Status Code
Retrieved the list of subprojects in the tenant successfully.
Bad request
Unauthorized
Forbidden
Not found
No Sample Response
Retrieve a dataset
- Return the dataset metadata from seismic store.
- Required roles: subproject.admin, subproject.editor, subproject.viewer
GET /dataset/tenant/{tenantid}/subproject/{subprojectid}/dataset/{datasetid}Register a new dataset
- Register a new dataset in seismic store.
- Required roles: subproject.admin, subproject.editor
POST /dataset/tenant/{tenantid}/subproject/{subprojectid}/dataset/{datasetid}Request
Custom Headers
Legal tag of the dataset
Path Parameters
Name of the tenant
Name of the subproject
Name of the dataset
Query Parameters
Hierarchical path of the dataset
Request body
{
"type": "segy",
"gtags": [
"tagA",
"tagB",
"tagC"
],
"seismicmeta": {
"kind": "osdu:sdms:seismic3d:1.0.0",
"legal": {
"legaltags": [
"legal-tag"
],
"otherRelevantDataCountries": [
"US"
]
},
"data": {
"msg": "sample data"
}
}
}Array of global tags associated with the dataset metadata. Once assigned, they can be used to filter datasets
Seismic metadata to be stored as dataecosystem storage record
- seismicmeta
- data
Response
The SRN which identifies this OSDU File resource.
Status Code
Registered dataset metadata
Bad request
Unauthorized
Forbidden
Not found
Conflict
Locked. The error message contains the Reason in the form [RCODE:REASON(2-char-code)TTL(sec-number)]. Possible Reasons code are:
- WL(Write Locked)
- RL(Read Locked)
- CL(Cannot be Locked)
- UL(Cannot be Unlocked)
No Sample Response
Delete a dataset
- Delete a dataset in seismic store.
- Required roles: subproject.admin, subproject.editor
DELETE /dataset/tenant/{tenantid}/subproject/{subprojectid}/dataset/{datasetid}Patch the dataset metadata
- Update the dataset meta information in seismic store or close(unlock) the dataset. If the endpoint is used without the close parameter, at least one body field is required or the endpoint will return an error.
- Required roles: subproject.admin, subproject.editor
- Patchable fields:
- dataset_new_name: new name to use for the dataset (rename)
- filemetadata: this is a seistore specific field and describe how the physical data are stored in the cloud storage system (GCS/AzureContainer etc etc). This metadata is mainly used by client libraries to correctly reconstruct the dataset. For example you can store a dataset as truncated in multiple objects of 64MB each, name them from 0 to N and save the filemetadata = “{nOboject: N, totalSize: 1024, objsize: 64, sizeUnit: MB }”.
- last_modified_date: mark this field as true to update the dataset last modified date
- gtags: upsert tags to an existing dataset metadata. If the dataset metadata already has gtags, then new gtags are appended to this list.
- ltag: update the existing legalTag value
- readonly: update the dataset mode to readonly(true) or to read/write(false)
- seismicmeta: update the DataEcosystem storage metadata (refer to the DataEcosystem storage service tutorial for more help)
PATCH /dataset/tenant/{tenantid}/subproject/{subprojectid}/dataset/{datasetid}Request
Path Parameters
Name of the tenant
Name of the subproject
Name of the dataset
Query Parameters
Hierarchical path of the dataset
Non null sbit value of the dataset. Using this value here will close the dataset
Request body
{
"dataset_new_name": "dsx02",
"metadata": {
"f1": "v1",
"f2": "v2",
"f3": "v3"
},
"filemetadata": {
"f1": "v1",
"f2": "v2",
"f3": "v3"
},
"last_modified_date": "Thu Jul 16 2020 04:37:41 GMT+0000 (Coordinated Universal Time)",
"gtags": [
"tag01",
"tag02",
"tag03"
],
"ltag": "Slb-Private-USA-EHC",
"readonly": false,
"seismicmeta": {
"kind": "slb:seistore:seismic2d:1.0.0",
"legal": {
"legaltags": [
"Slb-Private-USA-EHC"
],
"otherRelevantDataCountries": [
"US"
]
},
"data": {
"msg": "sample data"
}
}
}New name for the dataset
Generic information about the dataset stored as key value pairs
- metadata
Number of objects and the size in bytes of the dataset
- filemetadata
Date when the dataset was last modified
Array of tags associated with the dataset. After patching these tags, they can be used to filter the datasets
Legal tag associated with the dataset
True if the dataset is readonly
Seismic metadata associated with the dataset which is used to create a data ecosystem storage record
- seismicmeta
- data
Response
The SRN which identifies this OSDU File resource.
Status Code
Metadata of the patched dataset
Bad request
Unauthorized
Forbidden
Not found
Conflict
Locked. The error message contains the Reason in the form [RCODE:REASON(2-char-code)TTL(sec-number)]. Possible Reasons code are:
- WL(Write Locked)
- RL(Read Locked)
- CL(Cannot be Locked)
- UL(Cannot be Unlocked)
No Sample Response
Acquire a lock for a dataset id
- Open a dataset for read or write and lock its state.
- Required roles open lock for write: subproject.admin, subproject.editor
- Required roles open lock for read: subproject.admin, subproject.editor, subproject.viewer
PUT /dataset/tenant/{tenantid}/subproject/{subprojectid}/dataset/{datasetid}/lockRequest
Path Parameters
Name of the tenant
Name of the subproject
Name of the dataset
Query Parameters
Hierarchical path of the dataset
Type of the lock which can be set to 'read' (default) or 'write'
Session identifier issued for a previous write lock acquisition operation
Response
The SRN which identifies this OSDU File resource.
Status Code
Acquired a lock and the return value is the dataset metadata with session identifier stored in 'sbit' attribute
Bad request
Unauthorized
Forbidden
Not found
Locked. The error message contains the Reason in the form [RCODE:REASON(2-char-code)TTL(sec-number)]. Possible Reasons code are:
- WL(Write Locked)
- RL(Read Locked)
- CL(Cannot be Locked)
- UL(Cannot be Unlocked)
No Sample Response
Remove the lock associated with a dataset id.
- Removes the lock for a dataset id.
- Required roles: subproject.admin
PUT /dataset/tenant/{tenantid}/subproject/{subprojectid}/dataset/{datasetid}/unlockRequest
Path Parameters
Name of the tenant
Name of the subproject
Name of the dataset
Query Parameters
Hierarchical path for the dataset
Response
Status Code
Removed the lock value associated with dataset id
Bad request
Unauthorized
Forbidden
Not found
Locked. The error message contains the Reason in the form [RCODE:REASON(2-char-code)TTL(sec-number)]. Possible Reasons code are:
- WL(Write Locked)
- RL(Read Locked)
- CL(Cannot be Locked)
- UL(Cannot be Unlocked)
No Sample Response
Retrieve the access permissions of a user on a dataset id
- Retrieve the access permission of a user on a dataset.
- Required roles: subproject.admin, subproject.editor, subproject.viewer
GET /dataset/tenant/{tenantid}/subproject/{subprojectid}/dataset/{datasetid}/permissionRequest
Path Parameters
Name of the tenant
Name of the subproject
Name of the dataset
Query Parameters
Hierarchical path for the dataset
Response
True if the user has read permission on the dataset
True if the user has write permission on the dataset
True if the user has delete permission on the dataset
Status Code
User access permission on the dataset.
Bad request
Unauthorized
Forbidden
Not found
{ "read": true, "write": false, "delete": false }
Validate if a dataset cTag matches the pre-existing cTag in metadata catalog
- Check if the provided dataset cTag match the one stored in the metadata catalog.
- Required roles: subproject.admin, subproject.editor, subproject.viewer
GET /dataset/tenant/{tenantid}/subproject/{subprojectid}/dataset/{datasetid}/ctagcheckUpsert tags to a dataset
- Upsert tags to an existing dataset metadata. If the dataset metadata already has gtags, then new gtags are appended to this list.
- Required roles: subproject.admin, subproject.editor
PUT /dataset/tenant/{tenantid}/subproject/{subprojectid}/dataset/{datasetid}/gtagscontent list
- List datasets and sub-directories for a directory path.
- Required roles: subproject.admin, subproject.editor, subproject.viewer
GET /dataset/tenant/{tenantid}/subproject/{subprojectid}/readdsdirfulllistGet the list of datasets in a subproject
- Return the list of datasets in a sub-project.If gtags are in the request parameters, then get only those datasets that have the exact list of gtags.
- Required roles: subproject.admin, subproject.editor, subproject.viewer
GET /dataset/tenant/{tenantid}/subproject/{subprojectid}Request
Path Parameters
Name of the tenant
Name of the subproject
Query Parameters
Gtags associated with dataset metadata
Response
The SRN which identifies this OSDU File resource.
Status Code
The list of all datasets in the subproject if no gtags are in the request parameters. If gtags exist in the request parameters, then datasets that have the same list of gtags.
Bad request
Unauthorized
Forbidden
Not found
No Sample Response
Check if a list of datasets exists in the subproject
- Check if the dataset exists.
- Required roles: subproject.admin, subproject.editor, subproject.viewer
POST /dataset/tenant/{tenantid}/subproject/{subprojectid}/existRetrieve the size of datasets
- Return a list with the sizes of the requested datasets.
- Required roles: subproject.admin, subproject.editor, subproject.viewer
POST /dataset/tenant/{tenantid}/subproject/{subprojectid}/sizesRetrieve list of datasets and sub-directories inside a seismic store path
- Return the list of datasets and sub-directories of a seismic store path.
- Required roles: subproject.admin, subproject.editor, subproject.viewer
GET /utility/ls
Request
Query Parameters
Seismic store path, sd://tenant/sub-project/path
Working mode, dirs or datasets or undefined for both
Limits total number of datasets to be returned
Pagination token - this query parameter can be omitted on first call
Response
Array of directories and datasets inside a subproject
Status Code
Seismic store path content
Paginated seismic store path content - For documentation purpose if limit or cursor is given status code here is 200
Bad request
Unauthorized
Forbidden
Not found
[ "subdirA/", "subdirB/", "dataset01", "dataset02", "dataset03" ]{ "datasets": [ "subdirA/", "subdirB/", "dataset01" ], "nextPageCursor": "abc1234" }
Copy dataset
- Copy a seismic store dataset. The source and destination dataset must be in the same sub-project.
- Required roles: subproject.admin, subproject.editor
POST /utility/cp
Request
Query Parameters
Seismic store source dataset path
Seismic store destination dataset path
Lock source and destination while copying
Response
Status Code
Copy operation succeeded
Bad request
Unauthorized
Forbidden
Not found
Conflict
Locked. The error message contains the Reason in the form [RCODE:REASON(2-char-code)TTL(sec-number)]. Possible Reasons code are:
- WL(Write Locked)
- RL(Read Locked)
- CL(Cannot be Locked)
- UL(Cannot be Unlocked)
No Sample Response
Generate a GCS access token
- Generate a GCS access token for a specified seismic store resource. The source and destination dataset must be in the same sub-project.
- Required roles: subproject.admin, subproject.editor, subproject.viewer
GET /utility/gcs-access-token
Request
Query Parameters
Seismic store path in the format sd://tenant/sub-project
Readonly access, true(default) or false
Response
Access token
Type of the token
Time in seconds for expiration of the access token
Status Code
The GCS access token
Bad request
Unauthorized
Forbidden
Not found
{ "access_token": "ya29.fgdgsdngevrjbinb0ednberoibnerbnerber-fdsfwefwe_cece", "token_type": "Bearer", "expires_in": 3600 }
Add an user to a seismic store subproject authorization group
- Add an user to a subproject authorization group.
- Required roles: subproject.admin
PUT /user
Remove user from subproject's role based authorization groups
- Remove user from subproject's role based authorization groups.
- Required roles: subproject.admin
DELETE /user