Fetch a single well constraint by sourceId

GET

https://data.onxecta.com/api/production/network/{sourceNetworkId}/{sourceWellId}/constraint/{sourceId}

Path Parameters

sourceNetworkIdstringrequired
sourceWellIdstringrequired
sourceIdstringrequired

Responses

200OK

NetworkWellConstraint
- xidstring<uuid>required
  Description
  xecta unique identifier
  Format
  uuid
- sourceNetworkIdstringrequired
  Description
  Source ID of the network definition
- sourceWellIdstringrequired
  Description
  Source ID of the network well definition
- sourceIdstringrequired
  Description
  Source ID for the well/date constraint. This sourceID enables upsert functionality from client source systems of record
- datestring<date-time>required
  Description
  Date at which the constraint becomes applicable. Datetime offset (with timezone) in ISO 8601 format. Example: 2022-09-27T16:28
  +0000
  Format
  date-time
- maxPressurenumber<double>
  Description
  Maximum pressure constraint, psig
  Format
  double
- minPressurenumber<double>
  Description
  Minimum pressure constraint, psig
  Format
  double
- maxOilRatenumber<double>
  Description
  Maximum oil rate constraint, STB/d
  Format
  double
- maxGasRatenumber<double>
  Description
  Maximum gas rate constraint, Mscf/d
  Format
  double
- maxWaterRatenumber<double>
  Description
  Maximum water rate constraint, STB/d
  Format
  double
- maxLiquidRatenumber<double>
  Description
  Maximum liquid rate constraint, STB/d
  Format
  double
- maxDrawDownnumber<double>
  Description
  Maximum drawdown constraint (Reservoir pressure - bottomhole pressure), psig
  Format
  double
- maxGasLiftInjectionRatenumber<double>
  Description
  Maximum gas lift injection rate, Mscf/d
  Format
  double
- minGasLiftInjectionRatenumber<double>
  Description
  Minimum gas lift injection rate, Mscf/d
  Format
  double
- maxGasLiftInjectionPressurenumber<double>
  Description
  Maximum gas lift injection pressure, psig
  Format
  double
- minGasLiftInjectionPressurenumber<double>
  Description
  Minimum gas lift injection pressure, psig
  Format
  double
- plannedDowntimenumber<double>
  Description
  Planned downtime in percent (100% == 24 hours)
  Format
  double

curl

curl --request GET \
     --url https://data.onxecta.com/api/production/network/{sourceNetworkId}/{sourceWellId}/constraint/{sourceId} \
     --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/network/{sourceNetworkId}/{sourceWellId}/constraint/{sourceId}", 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/network/{sourceNetworkId}/{sourceWellId}/constraint/{sourceId}"

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/network/{sourceNetworkId}/{sourceWellId}/constraint/{sourceId}", 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/network/{sourceNetworkId}/{sourceWellId}/constraint/{sourceId}")
   .method("GET", body)
   .addHeader("accept", "application/json")
   .addHeader("content-type", "application/json")
   .build();
Response response = client.newCall(request).execute();

200

// OK
{
  "xid": "",
  "sourceNetworkId": "",
  "sourceWellId": "",
  "sourceId": "",
  "date": "",
  "maxPressure": "",
  "minPressure": "",
  "maxOilRate": "",
  "maxGasRate": "",
  "maxWaterRate": "",
  "maxLiquidRate": "",
  "maxDrawDown": "",
  "maxGasLiftInjectionRate": "",
  "minGasLiftInjectionRate": "",
  "maxGasLiftInjectionPressure": "",
  "minGasLiftInjectionPressure": "",
  "plannedDowntime": ""
}