Wellbore API (Open Data for Industries)

Using Wellbore DDMS API

Wellbore DDMS API for data lifecycle management

Wellbore DDMS API is segregated to support the lifecycle management of various well-related geological components.

Wellbore DDMS API for data contextualization

Use data contextualization to discover data in the right domain context. The Wellbore DDMS API has a rich set of endpoints to create and run a contextual search. The following table details out the simple and fast search endpoints.

Wellbore DDMS API for data enrichment

Your data is acquired from different sources with different conventions followed. Therefore, you need a mechanism to classify and tag the data at the system and identify it as different log mnemonics. To help you search and identify the log data that is logged, a classification to groups or families based on the unit of measurement is created.

The Log Recognition API endpoint uses a default catalog of assignment rules. The default catalog identifies the log family by using the log name and or mnemonics, the log unit, and the description provided.

In case you need a new set of assignment rules per data partition, you create a custom catalog.

The Log Recognition service also provides you with a way to assign the family attribute to logs. This assignment is done by using the log name (or its mnemonics), the description of the log, and the log unit of measurement.

The following table illustrates examples of how the Log Recognition service automatically tags and catalogs the logs’ data based on catalog definitions.

For example, if the curve name is GRD and the unit is GAPI, then the family can be identified as Gamma Ray.

The log recognition is achieved through the POST /api/log-recognition/recognize API endpoint. For more information, see Recognize family and unit endpoint.

How to create a custom catalog

The custom catalog consists of the catalog item and the main family catalog item. The following attributes must be defined:

Unit of the log

Family of the log

Rule or Mnemonic

Family assignment rule.

Main Family

Unit of the Family

The "Unit" attribute is used to define which unit the Family has.

To create a custom catalog, use the PUT /log-recognition/upload-catalog API endpoint. For more information, see Upload user-defined catalog with family assignment rules.

{
  "data": {
    "family_catalog": [
      {
        "unit": "Kg/m3",
        "family": "Bulk Density",
        "rule": "BL1M"
      },
      {
        "unit": "OHMM",
        "family": "Deep Resistivity",
        "rule": "RDPL"
      },
      {
        "unit": "mm",
        "family": "Caliper",
        "rule": "PFC2"
      },
      {
        "unit": "OHMM",
        "family": "Micro Spherically Focused Resistivity",
        "rule": "MICR"
      },
      {
        "unit": "mS/ft",
        "family": "Conductivity - Deep Induction",
        "rule": "ALCD1"
      },
      {
        "unit": "PU",
        "family": "Thermal Neutron Porosity",
        "rule": "CNCQH"
      },
      {
        "unit": "PU",
        "family": "Thermal Neutron Porosity",
        "rule": "CNCQH2"
      }
    ],
    "main_family_catalog": [
      {
        "MainFamily": "Density",
        "Family": "Bulk Density",
        "Unit": "g/cm3"
      },
      {
        "MainFamily": "Resistivity",
        "Family": "Deep Resistivity",
        "Unit": "ohm.m"
      },
      {
        "MainFamily": "Borehole Properties",
        "Family": "Caliper",
        "Unit": "in"
      },
      {
        "MainFamily": "Resistivity",
        "Family": "Micro Spherically Focused Resistivity",
        "Unit": "ohm.m"
      },
      {
        "MainFamily": "Conductivity",
        "Family": "Conductivity - Deep Induction",
        "Unit": "mS/m"
      },
      {
        "MainFamily": "Porosity",
        "Family": "Thermal Neutron Porosity",
        "Unit": "v/v"
      }
    ]
  }

Wellbore DDMS API for chunks and data change

Open Data for Industries supports a time-driven data upload for the well logs and well trajectory domains.

These domains are measured in chunks over a period, by using sessions.

The Wellbore API supports ingestion of such chunks with the help of the following API endpoints:

Wellbore DDMS API endpoint permissions

The Wellbore DDMS API is divided into logical blocks.

• Endpoints for data lifecycle management.
• Endpoints, which supplement the consumption or processing of the data. Such endpoints are the search and recognition endpoints.

Both categories have different set of minimum permissions that are required for access. Check the table to identify the permissions you need.