Fetch formations by well

GET

https://data.onxecta.com/api/production/well/{sourceWellId}/formation

Path Parameters

sourceWellIdstringrequired

Responses

200OK

Formation[]
- xidstring<uuid>required
  Description
  This is the xecta identifier
  Format
  uuid
- sourceIdstringrequired
- namestringrequired
- allocationFactornumber<double>
  Default
  1
  Format
  double
- compressibilityRocknumber<double>
  Description
  Formation rock compressibility
  Format
  double
- pressureFormationInitialDatumnumber<double>required
  Description
  The initial reservoir pressure value
  Format
  double
- temperatureFormationDatumnumber<double>required
  Description
  The reservoir temperature value
  Format
  double
- depthnumber<double>required
  Description
  Depth of the formation, ft
  Format
  double
- thicknessFormationnumber<double>
  Description
  Thickness of the formation
  Format
  double
- porositynumber<double>
  Description
  Porosity of the formation
  Format
  double
- saturationWaterInitialnumber<double>
  Description
  Initial water saturation
  Format
  double
- saturationGasInitialnumber<double>
  Description
  Initial gas saturation
  Format
  double
- saturationOilInitialnumber<double>
  Description
  Initial oil saturation
  Format
  double
- primaryFluidTypeFormationPrimaryFluidType
  Description
  OIL, GAS, WATER
  Default
  OIL
- rsinumber<double>required
  Description
  Initial solution gas oil ratio
  Format
  double
- condensateGasRationumber<double>
  Description
  Condensate gas Ratio
  Format
  double
- waterGasRationumber<double>
  Description
  Water gas ratio
  Format
  double
- originalGasInPlacenumber<double>
  Description
  Original Gas in Place
  Format
  double
- originalOilInPlacenumber<double>
  Description
  Original Oil In Place
  Format
  double
- volumeAquiferInitialnumber<double>
  Description
  Initial aquifer volume
  Format
  double
- fluidGravityApinumber<double>required
  Description
  Oil API gravity
  Format
  double
- fluidGravityGasnumber<double>required
  Description
  Gas specific gravity
  Format
  double
- fluidSalinityWaternumber<double>required
  Description
  Water salinity
  Format
  double
- fluidCommingledGORnumber<double>
  Description
  Gas Oil Ratio of the co-mingled fluid in multi wellbore wells
  Format
  double
- fluidMolarFracN2number<double>
  Description
  Molar fraction N2
  Default
  0
  Format
  double
- fluidMolarFracCO2number<double>
  Description
  Molar fraction CO2
  Default
  0
  Format
  double
- fluidMolarFracH2Snumber<double>
  Description
  Molar fraction H2S
  Default
  0
  Format
  double
- startDatestring<date-time>
  Description
  This is the valid date of the formation
  Format
  date-time
- langmuirPressurenumber<double>
  Description
  Langmuir pressure (for coal seam gas reservoirs)
  Format
  double
- langmuirVolumenumber<double>
  Description
  Langmuir volume (for coal seam gas reservoirs)
  Format
  double
- initialGasContentnumber<double>
  Description
  Initial gas content (for coal seam gas reservoirs)
  Format
  double
- bulkDensitynumber<double>
  Description
  Bulk density (for coal seam gas reservoirs)
  Format
  double

curl

curl --request GET \
     --url https://data.onxecta.com/api/production/well/{sourceWellId}/formation \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://data.onxecta.com/api/production/well/{sourceWellId}/formation", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

python

import requests
import json

url = "https://data.onxecta.com/api/production/well/{sourceWellId}/formation"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

csharp

var options = new RestClientOptions("https://data.onxecta.com")
{
   MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/api/production/well/{sourceWellId}/formation", Method.Get);
request.AddHeader("accept", "application/json");
request.AddHeader("content-type", "application/json");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

java

OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
   .url("https://data.onxecta.com/api/production/well/{sourceWellId}/formation")
   .method("GET", body)
   .addHeader("accept", "application/json")
   .addHeader("content-type", "application/json")
   .build();
Response response = client.newCall(request).execute();

200

// OK
[
  {
    "xid": "",
    "sourceId": "",
    "name": "",
    "allocationFactor": "",
    "compressibilityRock": "",
    "pressureFormationInitialDatum": "",
    "temperatureFormationDatum": "",
    "depth": "",
    "thicknessFormation": "",
    "porosity": "",
    "saturationWaterInitial": "",
    "saturationGasInitial": "",
    "saturationOilInitial": "",
    "primaryFluidType": "",
    "rsi": "",
    "condensateGasRatio": "",
    "waterGasRatio": "",
    "originalGasInPlace": "",
    "originalOilInPlace": "",
    "volumeAquiferInitial": "",
    "fluidGravityApi": "",
    "fluidGravityGas": "",
    "fluidSalinityWater": "",
    "fluidCommingledGOR": "",
    "fluidMolarFracN2": "",
    "fluidMolarFracCO2": "",
    "fluidMolarFracH2S": "",
    "startDate": "",
    "langmuirPressure": "",
    "langmuirVolume": "",
    "initialGasContent": "",
    "bulkDensity": ""
  }
]