Whitson+ data contract | PatchOps Knowledge

Provenance

PublisherWhitson+

API basehttps://internal.whitson.com/api-external/v1

Freshness & coverage

FreshnessFreshness not declared

GeographicNot declared

TemporalNot declared

AuthenticationCredentials required (Bearer token)

Methods (259)

get_auto_forecasts_auto_forecast_id

read

Get all info of Auto-Forecast setting with auto_forecast_id

Entitiesproduction

Input schema

{
  "type": "object",
  "properties": {
    "auto_forecast_id": {}
  },
  "additionalProperties": false,
  "required": [
    "auto_forecast_id"
  ]
}

put_auto_forecasts_auto_forecast_id_autofit

write

Autofit all wells in a Auto-Forecast with auto_forecast_id

Entitiesproduction

Input schema

{
  "type": "object",
  "properties": {
    "auto_forecast_id": {}
  },
  "additionalProperties": true,
  "required": [
    "auto_forecast_id"
  ]
}

patch_auto_forecasts_auto_forecast_id_monthly_rates
write
Export monthly DCA rates for all three phases for an Auto-Forecast.
Entitiesproduction
Input schema
```
{
  "type": "object",
  "properties": {
    "auto_forecast_id": {}
  },
  "additionalProperties": true,
  "required": [
    "auto_forecast_id"
  ]
}
```

patch_auto_forecasts_auto_forecast_id_tables

write

Return the Auto-Forecast export as JSON, Excel-equivalent (forecasts tables) (Whitson+).

Entitiesproduction

Input schema

{
  "type": "object",
  "properties": {
    "auto_forecast_id": {},
    "entity_name": {},
    "fit_start": {}
  },
  "additionalProperties": true,
  "required": [
    "auto_forecast_id"
  ]
}

get_fields

read

Get the complete list of all fields.

Entitiesfield

Input schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

get_fields_field_id_projects

read

Get the complete list of all projects under a field.

Entitiesproject, field

Input schema

{
  "type": "object",
  "properties": {
    "field_id": {}
  },
  "additionalProperties": false,
  "required": [
    "field_id"
  ]
}

post_fields_field_id_projects

unknown

Upload new project to the field specified by <field_id>.

Entitiesproject, field

Input schema

{
  "type": "object",
  "properties": {
    "field_id": {}
  },
  "additionalProperties": true,
  "required": [
    "field_id"
  ]
}

get_mass_fluid_data

read

Get an array with latest fluid data for all wells.

Entitiesrecord

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "well_name": {},
    "uwi_api": {},
    "external_id": {},
    "project_id": {}
  },
  "additionalProperties": false
}

get_mass_fluid_data_paginated

read

Get paginated mass fluid data for wells.

Entitiesrecord

Input schema

{
  "type": "object",
  "properties": {
    "page": {},
    "page_size": {},
    "well_id": {},
    "well_name": {},
    "uwi_api": {}
  },
  "additionalProperties": false
}

put_multi_well_gas_lift_opt_multi_well_gas_lift_id_change_injection_rate
write
put_multi_well_gas_lift_opt_multi_well_gas_lift_id_change_injection_rate
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {
    "multi_well_gas_lift_id": {}
  },
  "additionalProperties": true,
  "required": [
    "multi_well_gas_lift_id"
  ]
}
```

get_multi_well_gas_lift_opt_multi_well_gas_lift_id_results

read

Retrieves the summary of results for all wells in the gas lift optimizer.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "multi_well_gas_lift_id": {}
  },
  "additionalProperties": false,
  "required": [
    "multi_well_gas_lift_id"
  ]
}

get_multi_well_gas_lift_opt_multi_well_gas_lift_id_run

read

Launch the execution of the multi-well gas lift optimizer.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "multi_well_gas_lift_id": {},
    "operation_flag": {}
  },
  "additionalProperties": false,
  "required": [
    "multi_well_gas_lift_id"
  ]
}

get_multi_well_gas_lift_opt_multi_well_gas_lift_id_settings

read

Get configuration settings for the multi-well gas lift optimizer.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "multi_well_gas_lift_id": {}
  },
  "additionalProperties": false,
  "required": [
    "multi_well_gas_lift_id"
  ]
}

put_multi_well_gas_lift_opt_multi_well_gas_lift_id_settings

write

Update the configuration settings for the multi-well gas lift optimizer.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "multi_well_gas_lift_id": {}
  },
  "additionalProperties": true,
  "required": [
    "multi_well_gas_lift_id"
  ]
}

get_old_wells_paginated

read

OLD version, which contains metadata response. Get a list of wells (result paginated).

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "well_name": {},
    "uwi_api": {},
    "external_id": {},
    "project_id": {}
  },
  "additionalProperties": false
}

get_processes
read
Get all Whitson+ PVT compute processes.
Entitiesrecord
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}
```
post_processes
unknown
Upload new process (processes).
Entitiesrecord
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```

put_processes_process_id

write

Edit a process.

Entitiesrecord

Input schema

{
  "type": "object",
  "properties": {
    "process_id": {}
  },
  "additionalProperties": true,
  "required": [
    "process_id"
  ]
}

delete_processes_process_id

write

Delete a process.

Entitiesrecord

Input schema

{
  "type": "object",
  "properties": {
    "process_id": {}
  },
  "additionalProperties": false,
  "required": [
    "process_id"
  ]
}

post_projects_multi_well_gas_lift_opt
unknown
Add a new Multi Well Gas Lift Optimizer in an area
Entitiesproject, well
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```

delete_projects_multi_well_gas_lift_opt_multi_well_gas_lift_id

write

Delete a multi well gas lift optimizer project

Entitiesproject, well

Input schema

{
  "type": "object",
  "properties": {
    "multi_well_gas_lift_id": {}
  },
  "additionalProperties": false,
  "required": [
    "multi_well_gas_lift_id"
  ]
}

post_projects_multi_well_gas_lift_opt_areas
unknown
Add new Multi Well Gas Lift Area in a project
Entitiesproject, well
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
delete_projects_multi_well_gas_lift_opt_areas_multi_well_gas_lift_area_id
write
Delete a Multi Well Gas Lift Area with MULTI_WELL_GAS_LIFT_AREA_ID
Entitiesproject, well
Input schema
```
{
  "type": "object",
  "properties": {
    "multi_well_gas_lift_area_id": {}
  },
  "additionalProperties": false,
  "required": [
    "multi_well_gas_lift_area_id"
  ]
}
```
get_projects_project_id_max_production_date
read
Get the maximum production date of all wells in a project.
Entitiesproject, production
Input schema
```
{
  "type": "object",
  "properties": {
    "project_id": {}
  },
  "additionalProperties": false,
  "required": [
    "project_id"
  ]
}
```
get_projects_project_id_multi_well_gas_lift_opt_autopopulate_by_compressor_group
write
Automatically populates the multi-well gas lift optimizer.
Entitiesgas lift optimizer
Input schema
```
{
  "type": "object",
  "properties": {
    "project_id": {}
  },
  "additionalProperties": false,
  "required": [
    "project_id"
  ]
}
```
get_projects_project_id_multi_well_gas_lift_opt_list
read
Retrieves all multi-well gas lift optimizers and associated areas within the specified project.
Entitiesproject, well
Input schema
```
{
  "type": "object",
  "properties": {
    "project_id": {}
  },
  "additionalProperties": false,
  "required": [
    "project_id"
  ]
}
```

get_projects_project_id_type_well_areas

read

Retrieve all the type well areas in a project

Entitiesproject, well

Input schema

{
  "type": "object",
  "properties": {
    "project_id": {}
  },
  "additionalProperties": false,
  "required": [
    "project_id"
  ]
}

post_projects_project_id_type_well_areas

unknown

Create a type well area in a project

Entitiesproject, well

Input schema

{
  "type": "object",
  "properties": {
    "project_id": {}
  },
  "additionalProperties": true,
  "required": [
    "project_id"
  ]
}

get_projects_project_id_well_groups

read

Get all group tags in a project (projects groups) (Whitson+).

Entitiesproject, well

Input schema

{
  "type": "object",
  "properties": {
    "project_id": {}
  },
  "additionalProperties": false,
  "required": [
    "project_id"
  ]
}

post_projects_project_id_well_groups

unknown

Create a new group tag for wells in a project

Entitiesproject, well

Input schema

{
  "type": "object",
  "properties": {
    "project_id": {}
  },
  "additionalProperties": true,
  "required": [
    "project_id"
  ]
}

put_projects_project_id_well_groups

write

Edit group tag configuration in a project

Entitiesproject, well

Input schema

{
  "type": "object",
  "properties": {
    "project_id": {}
  },
  "additionalProperties": true,
  "required": [
    "project_id"
  ]
}

delete_projects_project_id_well_groups

write

Delete group tag in a project

Entitiesproject, well

Input schema

{
  "type": "object",
  "properties": {
    "project_id": {}
  },
  "additionalProperties": false,
  "required": [
    "project_id"
  ]
}

get_scenario

read

Get a list of scenario wells.

Entitiesproject

Input schema

{
  "type": "object",
  "properties": {
    "scenario_id": {},
    "main_well_id": {},
    "scenario_name": {},
    "owner": {},
    "owners": {}
  },
  "additionalProperties": false
}

delete_type_well_areas_type_well_area_id

write

Delete a type well area

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "type_well_area_id": {}
  },
  "additionalProperties": false,
  "required": [
    "type_well_area_id"
  ]
}

post_type_wells
unknown
Create a type well in a type well area
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```

put_type_wells

write

Edit a type well configuration

Entitieswell

Input schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}

delete_type_wells

write

Delete a type well

Entitieswell

Input schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

post_type_wells_saved_cases
unknown
Uploads Type Well DCA cases to the database
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
patch_type_wells_saved_cases
write
Retrieves all Type Well DCA saved cases for the given type well ids
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
delete_type_wells_saved_cases
write
Deletes Type Well DCA saved cases from the database
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}
```

get_well_monitoring_well_id_common_process_conversion

read

Get common process conversion data of the most recent well monitoring run

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "date": {},
    "from_date": {},
    "end_date": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

get_well_monitoring_well_id_composition_tracking

read

Get compositional tracking data of the most recent well monitoring run for

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "date": {},
    "from_date": {},
    "end_date": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

get_well_monitoring_well_id_separator_oil_shrinkage

read

Get separator oil shrinkage data of the most recent well monitoring run for

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "date": {},
    "from_date": {},
    "end_date": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

get_wells

read

Raw API page of Whitson+ wells (see listWells for the curated list).

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "well_name": {},
    "uwi_api": {},
    "external_id": {},
    "project_id": {}
  },
  "additionalProperties": false
}

post_wells

unknown

Upload and create a new well in Whitson+.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "add_default_wellbore": {}
  },
  "additionalProperties": true
}

patch_wells
write
Conviniently update partial info to many wells (header, completion, etc.).
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```

get_wells_active_production_data

read

Get the full active production data records of wells in bulk.

Entitiesproduction, well

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "well_name": {},
    "uwi_api": {},
    "external_id": {},
    "project_id": {}
  },
  "additionalProperties": false
}

patch_wells_arta_interpretations
write
Get classical analytical rta interpretation for provided well ids.
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
post_wells_autofit_multiphase_fmb
unknown
Perform MFMB autofit for multiple wells, with optional post-fit MFMB calculation using pressure
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
post_wells_autofit_multiphase_fmb_with_pavg_criteria
unknown
Perform MFMB autofit for multiple wells, with optional post-fit MFMB calculation using pressure
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```

get_wells_autofit_rta

write

Launch Numerical RTA autofit for multiple wells.

Entitieswell, RTA

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "well_name": {},
    "uwi_api": {},
    "external_id": {},
    "project_id": {}
  },
  "additionalProperties": false
}

get_wells_bhp_calculation

read

Get BHP calculation in bulk.

Entitiescalculation, well

Input schema

{
  "type": "object",
  "properties": {
    "return_all": {},
    "page": {},
    "page_size": {},
    "well_id": {},
    "well_name": {}
  },
  "additionalProperties": false
}

get_wells_bhp_calculation_status

read

Get BHP calculation status for many wells (excluding scenario).

Entitiescalculation, well

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "well_name": {},
    "uwi_api": {},
    "external_id": {},
    "project_id": {}
  },
  "additionalProperties": false
}

get_wells_bhp_calculation_with_gauge_data

read

Get BHP calculation and gauge data in bulk.

Entitiescalculation, well

Input schema

{
  "type": "object",
  "properties": {
    "return_all": {},
    "page": {},
    "page_size": {},
    "well_id": {},
    "well_name": {}
  },
  "additionalProperties": false
}

patch_wells_bhp_input_well_data
write
Fetch wellbore configuration entries for many well IDs in one query (bulk BHP input) (Whitson+).
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
post_wells_bhp_input_well_data_bulk
unknown
Bulk create/update wellbore configurations for many wells.
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```

put_wells_bhp_input_well_data_well_data_id

write

Edit one wellbore configuration entry of a BHP input (Whitson+).

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_data_id": {}
  },
  "additionalProperties": true,
  "required": [
    "well_data_id"
  ]
}

delete_wells_bhp_input_well_data_well_data_id

write

Delete one wellbore configuration entry of a BHP input (Whitson+).

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_data_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_data_id"
  ]
}

put_wells_bhp_input_well_data_well_data_id_gas_lift_data
write
Edit the gas lift valves of a wellbore configuration entry (BHP input) (Whitson+).
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {
    "well_data_id": {}
  },
  "additionalProperties": true,
  "required": [
    "well_data_id"
  ]
}
```
put_wells_bhp_input_well_data_well_data_id_well_data_casing_pipe_number
write
Edit one casing string of a wellbore configuration entry by pipe number (BHP input) (Whitson+).
Entitiescompletion, well
Input schema
```
{
  "type": "object",
  "properties": {
    "well_data_id": {},
    "pipe_number": {}
  },
  "additionalProperties": true,
  "required": [
    "well_data_id",
    "pipe_number"
  ]
}
```
delete_wells_bhp_input_well_data_well_data_id_well_data_casing_pipe_number
write
Delete one casing string of a wellbore configuration entry by pipe number (BHP input) (Whitson+).
Entitiescompletion, well
Input schema
```
{
  "type": "object",
  "properties": {
    "well_data_id": {},
    "pipe_number": {}
  },
  "additionalProperties": false,
  "required": [
    "well_data_id",
    "pipe_number"
  ]
}
```
put_wells_bhp_input_well_data_well_data_id_well_data_tubing_pipe_number
write
Edit one tubing string of a wellbore configuration entry by pipe number (BHP input) (Whitson+).
Entitiescompletion, well
Input schema
```
{
  "type": "object",
  "properties": {
    "well_data_id": {},
    "pipe_number": {}
  },
  "additionalProperties": true,
  "required": [
    "well_data_id",
    "pipe_number"
  ]
}
```
delete_wells_bhp_input_well_data_well_data_id_well_data_tubing_pipe_number
write
Delete one tubing string of a wellbore configuration entry by pipe number (BHP input) (Whitson+).
Entitiescompletion, well
Input schema
```
{
  "type": "object",
  "properties": {
    "well_data_id": {},
    "pipe_number": {}
  },
  "additionalProperties": false,
  "required": [
    "well_data_id",
    "pipe_number"
  ]
}
```
post_wells_bhp_input_well_deviation_survey
unknown
Bulk upload/edit well deviation surveys for multiple wells.
Entitiessurvey, well
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```

put_wells_bhp_inputs

write

### Body example

Entitieswell

Input schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}

patch_wells_bhp_inputs
write
Submit a list of well IDs to bulk-fetch their BHP inputs (Whitson+).
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
patch_wells_bhp_inputs_no_deviation_survey
write
Get BHP input for multiple wells (inputs deviation survey).
Entitiessurvey, well
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
put_wells_bhp_tuning_parameters
write
Edit the BHP tuning parameters for many wells.
Entitiesfacility, well
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
post_wells_bhp_well_data_default_status
read
post_wells_bhp_well_data_default_status
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```

post_wells_bulk

unknown

Bulk create new wells.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "add_default_wellbore": {}
  },
  "additionalProperties": true
}

get_wells_bulk_gas_lift_optimizer_results

read

Get gas lift optimizer results in bulk based on parameters specified. Uses pagination

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "page": {},
    "page_size": {},
    "well_id": {},
    "well_name": {},
    "uwi_api": {}
  },
  "additionalProperties": false
}

patch_wells_bulk_gas_lift_optimizer_results
write
Get gas lift optimizer results for selected wells.
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
patch_wells_bulk_run_current_ipr_vlp
write
Batch run ipr vlp for wells with IDs using last production data or average production data.
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
patch_wells_bulk_run_gas_lift_optimizer
write
Run gas lift optimizer for selected wells.
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
patch_wells_bulk_run_gradient
write
Run gradient for selected wells.
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
post_wells_copy_wells
unknown
Copy multiple wells to an existing project.
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
post_wells_custom_attributes_bulk
unknown
Upsert one {well_id, attribute_name, value} tuple per list item.
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
patch_wells_custom_attributes_bulk
write
Retrieve current custom-attribute values for multiple wells.
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
delete_wells_custom_attributes_bulk
write
Bulk deletion of custom-attribute values; ignores missing targets.
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}
```
post_wells_data_fields
read
Get a list of wells by their IDs with selected attributes (data fields).
Entitiesfield, well
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
patch_wells_dca
write
Retrieves all well DCAs for the given well ids
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
get_wells_dca_daily_rates
read
Export daily DCA rates for all three phases for a list of well_ids.
Entitiesproduction, well
Input schema
```
{
  "type": "object",
  "properties": {
    "well_ids": {}
  },
  "additionalProperties": false
}
```
get_wells_dca_monthly_rates
read
Export monthly DCA rates for all three phases for a list of well_ids.
Entitiesproduction, well
Input schema
```
{
  "type": "object",
  "properties": {
    "well_ids": {}
  },
  "additionalProperties": false
}
```
post_wells_dca_saved_case
unknown
post_wells_dca_saved_case
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
patch_wells_dca_saved_cases
write
Retrieves all well DCA saved cases for the given well ids
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
get_wells_dca_saved_cases_daily_rates
read
Export daily DCA rates for saved cases for a list of well_ids.
Entitiesproduction, well
Input schema
```
{
  "type": "object",
  "properties": {
    "well_ids": {}
  },
  "additionalProperties": false
}
```
get_wells_dca_saved_cases_monthly_rates
read
Export monthly DCA rates for saved cases for a list of well_ids.
Entitiesproduction, well
Input schema
```
{
  "type": "object",
  "properties": {
    "well_ids": {}
  },
  "additionalProperties": false
}
```
get_wells_fat_gas_rate
read
Bulk‐retrieve fat gas rate series (`common_process_conversion`
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {
    "well_ids": {}
  },
  "additionalProperties": false
}
```
put_wells_forecast_inputs
write
Edit Multiple Forecast Inputs
Entitiesproduction, well
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
put_wells_gradient_cases
write
Edit gradient cases in bulk.
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```

patch_wells_gradient_cases

write

Get gradient cases of selected wells

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "name": {},
    "date": {},
    "day": {}
  },
  "additionalProperties": true
}

put_wells_gradient_cases_gradient_case_id

write

Edit a gradient case.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "gradient_case_id": {}
  },
  "additionalProperties": true,
  "required": [
    "gradient_case_id"
  ]
}

delete_wells_gradient_cases_gradient_case_id

write

Delete a gradient case.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "gradient_case_id": {}
  },
  "additionalProperties": false,
  "required": [
    "gradient_case_id"
  ]
}

get_wells_history_matching

read

Get a list of history matching object.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "well_name": {},
    "uwi_api": {},
    "external_id": {},
    "project_id": {}
  },
  "additionalProperties": false
}

get_wells_history_matching_input

read

Get a list of history matching inputs.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "well_name": {},
    "uwi_api": {},
    "external_id": {},
    "project_id": {}
  },
  "additionalProperties": false
}

put_wells_history_matching_input
write
Edit history matching inputs for many wells.
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
post_wells_latest_date_gradient_cases
unknown
post_wells_latest_date_gradient_cases
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```

get_wells_light

read

get_wells_light

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "well_name": {},
    "uwi_api": {},
    "external_id": {},
    "project_id": {}
  },
  "additionalProperties": false
}

patch_wells_mass_export_custom_results
write
Retrieve certain data for wells, equivalent to well exports in Whitson+.
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```

get_wells_monthly_production_data

read

Get the monthly production records of wells in bulk

Entitiesproduction, well

Input schema

{
  "type": "object",
  "properties": {
    "page": {},
    "page_size": {},
    "well_id": {},
    "well_name": {},
    "uwi_api": {}
  },
  "additionalProperties": false
}

post_wells_monthly_production_data
unknown
Upload monthly production data in bulk.
Entitiesproduction, well
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
delete_wells_monthly_production_data
write
Delete monthly production data for the well WELL_ID.
Entitiesproduction, well
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}
```

get_wells_multi_well_arta_autofit_phase

write

Autofit straight line and TELF to existing production data

Entitieswell, RTA

Input schema

{
  "type": "object",
  "properties": {
    "phase": {},
    "well_id": {},
    "well_name": {},
    "uwi_api": {},
    "external_id": {},
    "project_id": {}
  },
  "additionalProperties": false,
  "required": [
    "phase"
  ]
}

get_wells_multi_well_fractional_arta_autofit_phase

write

Autofit straight line to existing production data

Entitieswell, RTA

Input schema

{
  "type": "object",
  "properties": {
    "phase": {},
    "well_id": {},
    "well_name": {},
    "uwi_api": {},
    "external_id": {},
    "project_id": {}
  },
  "additionalProperties": false,
  "required": [
    "phase"
  ]
}

get_wells_multiphase_fmb_interpretations

read

Get mutiphase fmb interpretation for wells in bulk

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "well_name": {},
    "uwi_api": {},
    "external_id": {},
    "project_id": {}
  },
  "additionalProperties": false
}

get_wells_multiphase_fmb_pavg

read

Get calculated MultiphaseFMB pressure average in bulk

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "well_name": {},
    "uwi_api": {},
    "external_id": {},
    "project_id": {}
  },
  "additionalProperties": false
}

patch_wells_multiphase_fmb_pavg
write
Get calculated MultiphaseFMB pressure average for selected wells with time filters
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {
    "date": {},
    "from_date": {},
    "end_date": {}
  },
  "additionalProperties": true
}
```

get_wells_new_well_input_status

read

Get the new well input status of a well

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "well_name": {},
    "uwi_api": {},
    "external_id": {},
    "project_id": {}
  },
  "additionalProperties": false
}

patch_wells_nodal_ipr_input
write
Get IPR input used in nodal_analysis for wells specified.
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
put_wells_nrta_weight_factors
write
Edit Numerical RTA weight factors for many wells.
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```

patch_wells_pi_from_ipr

write

Set initial reservoir pressure for wells based on IPR

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "start_day_offset": {},
    "end_day_offset": {},
    "bhp_correlation": {},
    "ipr_type": {},
    "turbulence_factor": {}
  },
  "additionalProperties": true
}

get_wells_pnr

read

get_wells_pnr

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "page": {},
    "page_size": {},
    "well_id": {},
    "well_name": {},
    "uwi_api": {}
  },
  "additionalProperties": false
}

get_wells_production_data

read

Get the production records of wells in bulk

Entitiesproduction, well

Input schema

{
  "type": "object",
  "properties": {
    "page": {},
    "page_size": {},
    "well_id": {},
    "well_name": {},
    "uwi_api": {}
  },
  "additionalProperties": false
}

post_wells_production_data
unknown
Upload production data in bulk.
Entitiesproduction, well
Input schema
```
{
  "type": "object",
  "properties": {
    "append_only": {}
  },
  "additionalProperties": true
}
```
delete_wells_production_data
write
Delete exactly the production timestamps given for each well.
Entitiesproduction, well
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}
```
patch_wells_production_data_dates
write
Update production data dates for multiple wells (expects a JSON payload).
Entitiesproduction, well
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```

get_wells_production_data_comments

read

Get production comments of wells in bulk

Entitiesproduction, well

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "well_name": {},
    "uwi_api": {},
    "external_id": {},
    "project_id": {}
  },
  "additionalProperties": false
}

post_wells_production_data_comments
unknown
Upload production comments in bulk
Entitiesproduction, well
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
patch_wells_pvt_calcs
write
Submit well IDs to bulk-fetch PVT calculation results (JSON payload) (Whitson+).
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
patch_wells_pvt_calculation_status
write
Submit well IDs to bulk-fetch their PVT calculation status (Whitson+).
Entitiescalculation, well
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```

get_wells_pwf_active

read

Get the active well flowing pressure. Default to return measured gauge

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "project_id": {},
    "date": {},
    "from_date": {},
    "end_date": {}
  },
  "additionalProperties": false
}

get_wells_pwf_custom

read

Get the custom well flowing pressure. Default to return measured gauge

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "project_id": {},
    "date": {},
    "from_date": {},
    "end_date": {}
  },
  "additionalProperties": false
}

get_wells_rta_autofit_rms

read

Get Numerical RTA autofit RMS for many wells.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "well_name": {},
    "uwi_api": {},
    "external_id": {},
    "project_id": {}
  },
  "additionalProperties": false
}

get_wells_rta_calc

read

Get RTA Calcs for many wells.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "well_name": {},
    "uwi_api": {},
    "external_id": {},
    "project_id": {}
  },
  "additionalProperties": false
}

get_wells_rta_input

read

Get the Numerical RTA input for many wells.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "well_name": {},
    "uwi_api": {},
    "external_id": {},
    "project_id": {}
  },
  "additionalProperties": false
}

put_wells_rta_input
write
Edit RTA input for many wells.
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```

get_wells_run_bhp_calculation

read

Run BHP calculations for many wells (excluding scenario).

Entitiescalculation, well

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "well_name": {},
    "uwi_api": {},
    "external_id": {},
    "project_id": {}
  },
  "additionalProperties": false
}

get_wells_run_composition_calc

read

Run PVT calculations for many wells (excluding scenarios) (composition).

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "well_name": {},
    "uwi_api": {},
    "external_id": {},
    "project_id": {}
  },
  "additionalProperties": false
}

get_wells_run_history_matching

read

Launch Numerical Model calculation on a list of wells.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "grid_refinement": {},
    "rate_control": {},
    "time_step_method": {},
    "include_forecast": {},
    "well_id": {}
  },
  "additionalProperties": false
}

post_wells_run_multiphase_fmb
unknown
Run an Multiphase FMB PWF and/or Multiphase FMB PAvg for many wells.
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```

get_wells_run_pvt_calcs

read

Run PVT calculations for many wells (excluding scenarios) (calcs).

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "well_name": {},
    "uwi_api": {},
    "external_id": {},
    "project_id": {}
  },
  "additionalProperties": false
}

get_wells_run_rta

read

Run numerical RTA on a list of wells.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "num_type_curves": {},
    "grid_refinement": {},
    "well_id": {},
    "well_name": {},
    "uwi_api": {}
  },
  "additionalProperties": false
}

post_wells_run_sales_products
unknown
Bulk‐trigger a new sales products calculation for each well.
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```

get_wells_run_well_monitoring

read

Run well monitoring calculations for multiple wells.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "well_name": {},
    "uwi_api": {},
    "external_id": {},
    "project_id": {}
  },
  "additionalProperties": false
}

put_wells_sales_products_input
write
Bulk upload / update Sales-Products inputs
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
get_wells_sales_products_rates
read
Bulk‐retrieve only the `ngl` & `ngl_common` series for each well's latest calc.
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {
    "well_ids": {}
  },
  "additionalProperties": false
}
```

get_wells_sampling_advanced_id

read

Get sampling data for sampling ID.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "id": {}
  },
  "additionalProperties": false,
  "required": [
    "id"
  ]
}

get_wells_sampling_data_id

read

Get sampling data for sampling ID.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "id": {}
  },
  "additionalProperties": false,
  "required": [
    "id"
  ]
}

get_wells_sampling_quick_id

read

Get sampling data for sampling ID.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "id": {}
  },
  "additionalProperties": false,
  "required": [
    "id"
  ]
}

get_wells_sampling_simplified_drygas_id

read

Get sampling data for sampling ID.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "id": {}
  },
  "additionalProperties": false,
  "required": [
    "id"
  ]
}

put_wells_update_surface_pressure_vlp
write
Update surface pressure for a well.
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```

get_wells_well_id

read

Get all info of well with ID.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

put_wells_well_id

write

Edit a well.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": true,
  "required": [
    "well_id"
  ]
}

patch_wells_well_id

write

Conviniently update partial info a well (header, completion, etc.).

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": true,
  "required": [
    "well_id"
  ]
}

delete_wells_well_id

write

Delete one well from Whitson+ by well ID.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

get_wells_well_id_active_production_data
read
Get the active production data for a well — one well by well ID.
Entitiesproduction, well
Input schema
```
{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}
```

put_wells_well_id_analytical_rta_input

write

Edit inputs for classical rta calculation for well <WELL_ID>.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": true,
  "required": [
    "well_id"
  ]
}

get_wells_well_id_approximate_gor_init

read

Approximate initial GOR for a well based on production data.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "is_separator_gor": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

get_wells_well_id_arta_interpretations

read

Get classical analytical rta interpretation for well <WELL_ID>

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

get_wells_well_id_arta_time_series

read

Get analytical rta time series for well <WELL_ID>

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

post_wells_well_id_autofit_multiphase_fmb
unknown
Perform an MFMB autofit for a single well, optionally followed by a full MFMB run with pressure
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": true,
  "required": [
    "well_id"
  ]
}
```
post_wells_well_id_autofit_multiphase_fmb_with_pavg_criteria
unknown
Perform an MFMB autofit for a single well, optionally followed by a full MFMB run with pressure
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": true,
  "required": [
    "well_id"
  ]
}
```

get_wells_well_id_autofit_rta

write

Autofit Numerical RTA LFP — one well by well ID.

Entitieswell, RTA

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

get_wells_well_id_available_custom_attributes

read

Get a list of available custom attributes for a well.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

get_wells_well_id_bhp_calculation

read

Get a BHP calculation — one well by well ID.

Entitiescalculation, well

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "date": {},
    "from_date": {},
    "end_date": {},
    "updated": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

get_wells_well_id_bhp_input

read

Get BHP input of the well of <well_id> in json format

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

put_wells_well_id_bhp_input

write

Edit a bhp input.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": true,
  "required": [
    "well_id"
  ]
}

get_wells_well_id_bhp_input_well_data

read

Get the wellbore configuration entries for a well (BHP input) (Whitson+).

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "use_from_date": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

post_wells_well_id_bhp_input_well_data
unknown
Create wellbore configuration entries on a BHP input (Whitson+).
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": true,
  "required": [
    "well_id"
  ]
}
```
get_wells_well_id_bhp_input_well_data_well_data_casing
read
Get the casing strings of a wellbore configuration entry (BHP input) (Whitson+).
Entitiescompletion, well
Input schema
```
{
  "type": "object",
  "properties": {
    "well_id": {},
    "use_from_date": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}
```
post_wells_well_id_bhp_input_well_data_well_data_casing
unknown
Create casing strings on a wellbore configuration entry (BHP input) (Whitson+).
Entitiescompletion, well
Input schema
```
{
  "type": "object",
  "properties": {
    "well_id": {},
    "use_from_date": {}
  },
  "additionalProperties": true,
  "required": [
    "well_id"
  ]
}
```
get_wells_well_id_bhp_input_well_data_well_data_tubing
read
Get the tubing strings of a wellbore configuration entry (BHP input) (Whitson+).
Entitiescompletion, well
Input schema
```
{
  "type": "object",
  "properties": {
    "well_id": {},
    "use_from_date": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}
```
post_wells_well_id_bhp_input_well_data_well_data_tubing
unknown
Create tubing strings on a wellbore configuration entry (BHP input) (Whitson+).
Entitiescompletion, well
Input schema
```
{
  "type": "object",
  "properties": {
    "well_id": {},
    "use_from_date": {}
  },
  "additionalProperties": true,
  "required": [
    "well_id"
  ]
}
```
get_wells_well_id_bhp_input_well_deviation_survey
read
Get the well deviation survey data of the well (BHP input).
Entitiessurvey, well
Input schema
```
{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}
```
put_wells_well_id_bhp_input_well_deviation_survey
write
Edit the deviation survey on a well BHP input (Whitson+).
Entitiessurvey, well
Input schema
```
{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": true,
  "required": [
    "well_id"
  ]
}
```

get_wells_well_id_bot_bot_table

read

Get BOT table for a well.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

get_wells_well_id_calculate_analytical_rta

read

Calculate analytical rta for well <WELL_ID>

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

put_wells_well_id_classical_rta_input_t_elf
write
Edit the t_elf input for classical rta calculation for well <WELL_ID>.
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": true,
  "required": [
    "well_id"
  ]
}
```

get_wells_well_id_cum_lfp

read

Get cumulative LFP for a well.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

get_wells_well_id_custom_attributes

read

Get the custom attributes of a well.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

post_wells_well_id_custom_attributes

unknown

Add a custom attribute to a well.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": true,
  "required": [
    "well_id"
  ]
}

delete_wells_well_id_custom_attributes_attribute_name

write

Delete a custom attribute value from a well.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "attribute_name": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id",
    "attribute_name"
  ]
}

get_wells_well_id_custom_bhp_calculation

read

Get a Custom BHP calculation.

Entitiescalculation, well

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "date": {},
    "from_date": {},
    "end_date": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

get_wells_well_id_fetch_from_ipr

read

Fetch from IPR the gas lift optimizer cases of a well.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

put_wells_well_id_forecast_input

write

Edit Forecast Input

Entitiesproduction, well

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": true,
  "required": [
    "well_id"
  ]
}

get_wells_well_id_fractional_arta_interpretations
read
Get fractional analytical rta interpretation for well <WELL_ID>
Entitiesfrac_job, completion, well
Input schema
```
{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}
```
get_wells_well_id_gas_fmb_material_balance_pseudotime
read
Get flow material balance time and mass rate normalized density change @ Pwf.
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}
```

get_wells_well_id_gas_lift_optimizer_cases

read

Get the gas lift optimizer cases of a well.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "name": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

post_wells_well_id_gas_lift_optimizer_cases

unknown

Create a gas lift optimizer case of a well.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": true,
  "required": [
    "well_id"
  ]
}

put_wells_well_id_gas_lift_optimizer_cases_gas_lift_case_id

write

Edit a gas lift optimizer case.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "gas_lift_case_id": {}
  },
  "additionalProperties": true,
  "required": [
    "well_id",
    "gas_lift_case_id"
  ]
}

delete_wells_well_id_gas_lift_optimizer_cases_gas_lift_case_id

write

Delete a gas lift optimizer case.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "gas_lift_case_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id",
    "gas_lift_case_id"
  ]
}

get_wells_well_id_gradient_cases

read

Get the gradient cases of a well.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "name": {},
    "date": {},
    "day": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

post_wells_well_id_gradient_cases

unknown

Create gradient cases for a well.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": true,
  "required": [
    "well_id"
  ]
}

post_wells_well_id_groups_group_name

unknown

Add a group to a well.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "group_name": {}
  },
  "additionalProperties": true,
  "required": [
    "well_id",
    "group_name"
  ]
}

delete_wells_well_id_groups_group_name

write

Remove a group tag from a well by group name (Whitson+).

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "group_name": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id",
    "group_name"
  ]
}

get_wells_well_id_history_matching

read

Get a list of history matching object — one well by well ID.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

put_wells_well_id_history_matching_input
write
Edit a history matching input, toggling the include_forecast flag — one well by well ID.
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": true,
  "required": [
    "well_id"
  ]
}
```

get_wells_well_id_input_quick

read

Get PVT input of a well.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

put_wells_well_id_input_quick

write

Edit PVT input of a well.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": true,
  "required": [
    "well_id"
  ]
}

get_wells_well_id_input_simplified_dry_gas

read

Get PVT input of a well.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

put_wells_well_id_input_simplified_dry_gas

write

Edit PVT input of a well.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": true,
  "required": [
    "well_id"
  ]
}

get_wells_well_id_ipr

read

Get IPR data for a well.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

get_wells_well_id_last_bhp_calc_time

read

Get the last BHP calculation time for a well.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

get_wells_well_id_material_balance_time

read

Get oil, gas and water material balance time for well <WELL_ID>

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

get_wells_well_id_max_production_date

read

Get the maximum production date of a well.

Entitiesproduction, well

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

get_wells_well_id_multiphase_fmb_interpretations
read
Get mutiphase fmb interpretation for a well (multiphase interpretations) — one well by well ID.
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}
```
get_wells_well_id_multiphase_fmb_pavg
read
Get a list of calculated MultiphaseFMB pressure average for a well — one well by well ID.
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}
```
get_wells_well_id_multiphase_fmb_pwf
read
Get flow material balance time and mass rate normalized density change @ Pwf
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}
```

get_wells_well_id_ngl_calculation_result

read

Get the NGL calculation results for a well

Entitiescalculation, well

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

put_wells_well_id_ngl_efficiencies

write

Edit the NGL efficiencies for a well

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": true,
  "required": [
    "well_id"
  ]
}

get_wells_well_id_pi_from_ipr

write

Set initial reservoir pressure for a well based on IPR (pi from).

Entitieswell, reservoir pressure

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "start_day_offset": {},
    "end_day_offset": {},
    "bhp_correlation": {},
    "ipr_type": {},
    "turbulence_factor": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

get_wells_well_id_processes

read

Get PVT process for a well.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

put_wells_well_id_processes

write

Edit PVT process for a well.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": true,
  "required": [
    "well_id"
  ]
}

get_wells_well_id_production_data

read

Get the production records of a well — one well by well ID.

Entitiesproduction, well

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "from_date": {},
    "end_date": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

post_wells_well_id_production_data

unknown

Upload production data for <well_id>.

Entitiesproduction, well

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "append_only": {}
  },
  "additionalProperties": true,
  "required": [
    "well_id"
  ]
}

put_wells_well_id_production_data

write

Partial upload and edit production data for <well_id>.

Entitiesproduction, well

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": true,
  "required": [
    "well_id"
  ]
}

delete_wells_well_id_production_data

write

Delete production data for <well_id> based on a start date and end date — one well by well ID.

Entitiesproduction, well

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "start_date": {},
    "end_date": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

delete_wells_well_id_production_data_comments

write

Delete production data comments for <well_id> based on a start date and end date.

Entitiesproduction, well

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "start_date": {},
    "end_date": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

get_wells_well_id_pvt_input

read

Get PVT input of a well.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

put_wells_well_id_pvt_input

write

Edit PVT input of a well.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": true,
  "required": [
    "well_id"
  ]
}

get_wells_well_id_pwf_active

read

Get the active well flowing pressure. Default to return measured gauge — one well by well ID.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "date": {},
    "from_date": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

get_wells_well_id_rta_autofit_rms

read

Get Numerical RTA autofit RMS for a well — one well by well ID.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

get_wells_well_id_rta_calc

read

Get RTA Calc for a well — one well by well ID.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

get_wells_well_id_rta_input

read

Get the Numerical RTA input of a well — one well by well ID.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

put_wells_well_id_rta_input

write

Edit an RTA input — one well by well ID.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": true,
  "required": [
    "well_id"
  ]
}

put_wells_well_id_rta_lfp

write

put_wells_well_id_rta_lfp

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": true,
  "required": [
    "well_id"
  ]
}

put_wells_well_id_run_autofit_history_matching
write
Run an autofit history matching calculation. Either pass all new weights or none to use existing.
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": true,
  "required": [
    "well_id"
  ]
}
```

get_wells_well_id_run_bhp_calculation

read

Run BHP calculations for a single well.

Entitiescalculation, well

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

get_wells_well_id_run_composition_calc

read

Run PVT calculation for a single well.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

patch_wells_well_id_run_gas_lift_optimizer_case

write

Run gas lift optimizer calculation for selected cases.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": true,
  "required": [
    "well_id"
  ]
}

get_wells_well_id_run_gradient

read

Run gradient calculation for selected cases.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "name": {},
    "date": {},
    "day": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

get_wells_well_id_run_history_matching

read

Run history matching calculation on a well — one well by well ID.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "grid_refinement": {},
    "rate_control": {},
    "time_step_method": {},
    "include_forecast": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

get_wells_well_id_run_ipr_with_date

read

Fetch the current production data for a well and run the VLP calculation.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "day": {},
    "date": {},
    "from_day": {},
    "from_date": {},
    "reservoir_pressure": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

get_wells_well_id_run_multiphase_fmb

read

Run an Multiphase FMB PWF and/or Multiphase FMB PAvg.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

get_wells_well_id_run_ngl_calculation

read

Run NGL calculation on a well

Entitiescalculation, well

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

get_wells_well_id_run_pvt_calc

read

Run PVT calculation for a single well.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

get_wells_well_id_run_rta

read

Run numerical RTA on a well — one well by well ID.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "num_type_curves": {},
    "grid_refinement": {},
    "time_step_method": {},
    "time_step_frequency": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

get_wells_well_id_run_simulated_pvt_study

read

Run a simulated PVT study calculation.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

patch_wells_well_id_run_vlp

write

Run VLP calculation for selected cases.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": true,
  "required": [
    "well_id"
  ]
}

get_wells_well_id_run_well_monitoring

read

Run well monitoring calculation for a well — one well by well ID.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "compute_compositions": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

get_wells_well_id_sampling_data
read
Gets all of the sampling inputs attached to the well with well_id <WELL_ID> in the database.
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}
```
post_wells_well_id_sampling_data
unknown
Upload a sampling data input. REMOVES any existing samples on the same date for the well.
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": true,
  "required": [
    "well_id"
  ]
}
```
get_wells_well_id_sampling_inputs
read
Gets all of the sampling inputs attached to the well with well_id <WELL_ID> in the database.
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}
```
post_wells_well_id_sampling_inputs
unknown
Upload a sampling data input. REMOVES any existing samples on the same date for the well.
Entitieswell
Input schema
```
{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": true,
  "required": [
    "well_id"
  ]
}
```

delete_wells_well_id_sampling_inputs_date

write

Delete a sampling input.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "date": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id",
    "date"
  ]
}

put_wells_well_id_set_production_rate_type_rate_type

write

Set the production rate type of a well.

Entitiesproduction, well

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "rate_type": {}
  },
  "additionalProperties": true,
  "required": [
    "well_id",
    "rate_type"
  ]
}

get_wells_well_id_simulated_pvt_study

read

Get a simulated PVT study.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

get_wells_well_id_status

read

Get the data status of a well

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

put_wells_well_id_vlp_case_vlp_case_id

write

Edit a VLP case.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "vlp_case_id": {}
  },
  "additionalProperties": true,
  "required": [
    "well_id",
    "vlp_case_id"
  ]
}

delete_wells_well_id_vlp_case_vlp_case_id

write

Delete a VLP case.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "vlp_case_id": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id",
    "vlp_case_id"
  ]
}

get_wells_well_id_vlp_cases

read

Get all VLP cases of a well

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "name": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

post_wells_well_id_vlp_cases

unknown

Post a VLP case of a well

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {}
  },
  "additionalProperties": true,
  "required": [
    "well_id"
  ]
}

get_wells_well_id_well_dca_dca_export

read

Get Well DCA results for all three phases.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "entity_name": {},
    "fit_start": {},
    "qualifier": {},
    "use_last_rate": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

get_wells_well_id_well_dca_saved_cases

read

Get a list of WellDCASavedCase object to a well.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {},
    "name": {},
    "fluid": {}
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

get_wells_paginated

read

Get a list of wells (result paginated).

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "page": {},
    "page_size": {},
    "well_id": {},
    "well_name": {},
    "uwi_api": {}
  },
  "additionalProperties": false
}

listFields

read

List all Whitson+ fields.

Entitiesfield

Input schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

listProjects

read

List projects under one Whitson+ field.

Entitiesproject, field

Input schema

{
  "type": "object",
  "properties": {
    "field_id": {
      "oneOf": [
        {
          "type": "integer"
        },
        {
          "type": "string"
        }
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "field_id"
  ]
}

listWells

read

List wells with optional Whitson+ identity filters.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {
      "oneOf": [
        {
          "type": "integer"
        },
        {
          "type": "string"
        }
      ]
    },
    "well_name": {
      "type": "string"
    },
    "uwi_api": {
      "type": "string"
    },
    "external_id": {
      "type": "string"
    },
    "project_id": {
      "oneOf": [
        {
          "type": "integer"
        },
        {
          "type": "string"
        }
      ]
    }
  },
  "additionalProperties": false
}

getWell

read

Fetch a single Whitson+ well record by its well ID.

Entitieswell

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {
      "oneOf": [
        {
          "type": "integer"
        },
        {
          "type": "string"
        }
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

getProductionData

read

Get production records for one well.

Entitiesproduction, well

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {
      "oneOf": [
        {
          "type": "integer"
        },
        {
          "type": "string"
        }
      ]
    },
    "from_date": {
      "type": "string"
    },
    "end_date": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "well_id"
  ]
}

getMonthlyProduction

read

List monthly production records with bounded paging and well filters.

Entitiesproduction, well

Input schema

{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "minimum": 1
    },
    "page_size": {
      "type": "integer",
      "minimum": 1
    },
    "well_id": {
      "oneOf": [
        {
          "type": "integer"
        },
        {
          "type": "string"
        }
      ]
    },
    "well_name": {
      "type": "string"
    },
    "uwi_api": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

getDCA

read

Retrieve DCA results for selected wells.

Entitieswell, forecast

Input schema

{
  "type": "object",
  "properties": {
    "well_ids": {
      "type": "array",
      "items": {
        "oneOf": [
          {
            "type": "integer"
          },
          {
            "type": "string"
          }
        ]
      },
      "minItems": 1
    }
  },
  "additionalProperties": false,
  "required": [
    "well_ids"
  ]
}

getDCAMonthlyRates

read

Export monthly DCA rates for selected wells (Whitson+).

Entitieswell, forecast

Input schema

{
  "type": "object",
  "properties": {
    "well_ids": {
      "type": "array",
      "items": {
        "oneOf": [
          {
            "type": "integer"
          },
          {
            "type": "string"
          }
        ]
      },
      "minItems": 1
    }
  },
  "additionalProperties": false,
  "required": [
    "well_ids"
  ]
}

getPVTCalcs

read

Retrieve PVT calculation results for selected wells.

Entitieswell, calculation

Input schema

{
  "type": "object",
  "properties": {
    "well_ids": {
      "type": "array",
      "items": {
        "oneOf": [
          {
            "type": "integer"
          },
          {
            "type": "string"
          }
        ]
      },
      "minItems": 1
    }
  },
  "additionalProperties": false,
  "required": [
    "well_ids"
  ]
}

getBHPCalculation

read

Curated summary of BHP calculation results across wells, optional filters (Whitson+ alias).

Entitieswell, calculation

Input schema

{
  "type": "object",
  "properties": {
    "return_all": {
      "type": "boolean"
    },
    "page": {
      "type": "integer",
      "minimum": 1
    },
    "page_size": {
      "type": "integer",
      "minimum": 1
    },
    "well_id": {
      "oneOf": [
        {
          "type": "integer"
        },
        {
          "type": "string"
        }
      ]
    },
    "well_name": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

getRTACalc

read

Curated RTA calculation results with optional well filters (Whitson+ alias).

Entitieswell, calculation

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {
      "oneOf": [
        {
          "type": "integer"
        },
        {
          "type": "string"
        }
      ]
    },
    "well_name": {
      "type": "string"
    },
    "uwi_api": {
      "type": "string"
    },
    "external_id": {
      "type": "string"
    },
    "project_id": {
      "oneOf": [
        {
          "type": "integer"
        },
        {
          "type": "string"
        }
      ]
    }
  },
  "additionalProperties": false
}

getHistoryMatching

read

Get history-matching results with optional well filters.

Entitieswell, calculation

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {
      "oneOf": [
        {
          "type": "integer"
        },
        {
          "type": "string"
        }
      ]
    },
    "well_name": {
      "type": "string"
    },
    "uwi_api": {
      "type": "string"
    },
    "external_id": {
      "type": "string"
    },
    "project_id": {
      "oneOf": [
        {
          "type": "integer"
        },
        {
          "type": "string"
        }
      ]
    }
  },
  "additionalProperties": false
}

getMultiphaseFMBInterpretations

read

Get multiphase FMB interpretations with optional well filters.

Entitieswell, calculation

Input schema

{
  "type": "object",
  "properties": {
    "well_id": {
      "oneOf": [
        {
          "type": "integer"
        },
        {
          "type": "string"
        }
      ]
    },
    "well_name": {
      "type": "string"
    },
    "uwi_api": {
      "type": "string"
    },
    "external_id": {
      "type": "string"
    },
    "project_id": {
      "oneOf": [
        {
          "type": "integer"
        },
        {
          "type": "string"
        }
      ]
    }
  },
  "additionalProperties": false
}

getAutoForecast

read

Get one auto-forecast configuration by ID.

Entitiesforecast

Input schema

{
  "type": "object",
  "properties": {
    "auto_forecast_id": {
      "oneOf": [
        {
          "type": "integer"
        },
        {
          "type": "string"
        }
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "auto_forecast_id"
  ]
}

Whitson+

Provenance

Freshness & coverage

Methods (259)

get_auto_forecasts_auto_forecast_id

put_auto_forecasts_auto_forecast_id_autofit

patch_auto_forecasts_auto_forecast_id_monthly_rates

patch_auto_forecasts_auto_forecast_id_tables

get_fields

get_fields_field_id_projects

post_fields_field_id_projects

get_mass_fluid_data

get_mass_fluid_data_paginated

put_multi_well_gas_lift_opt_multi_well_gas_lift_id_change_injection_rate

get_multi_well_gas_lift_opt_multi_well_gas_lift_id_results

get_multi_well_gas_lift_opt_multi_well_gas_lift_id_run

get_multi_well_gas_lift_opt_multi_well_gas_lift_id_settings

put_multi_well_gas_lift_opt_multi_well_gas_lift_id_settings

get_old_wells_paginated

get_processes

post_processes

put_processes_process_id

delete_processes_process_id

post_projects_multi_well_gas_lift_opt

delete_projects_multi_well_gas_lift_opt_multi_well_gas_lift_id

post_projects_multi_well_gas_lift_opt_areas

delete_projects_multi_well_gas_lift_opt_areas_multi_well_gas_lift_area_id

get_projects_project_id_max_production_date

get_projects_project_id_multi_well_gas_lift_opt_autopopulate_by_compressor_group

get_projects_project_id_multi_well_gas_lift_opt_list

get_projects_project_id_type_well_areas

post_projects_project_id_type_well_areas

get_projects_project_id_well_groups

post_projects_project_id_well_groups

put_projects_project_id_well_groups

delete_projects_project_id_well_groups

get_scenario

delete_type_well_areas_type_well_area_id

post_type_wells

put_type_wells

delete_type_wells

post_type_wells_saved_cases

patch_type_wells_saved_cases

delete_type_wells_saved_cases

get_well_monitoring_well_id_common_process_conversion

get_well_monitoring_well_id_composition_tracking

get_well_monitoring_well_id_separator_oil_shrinkage

get_wells

post_wells

patch_wells

get_wells_active_production_data

patch_wells_arta_interpretations

post_wells_autofit_multiphase_fmb

post_wells_autofit_multiphase_fmb_with_pavg_criteria

get_wells_autofit_rta

get_wells_bhp_calculation

get_wells_bhp_calculation_status

get_wells_bhp_calculation_with_gauge_data

patch_wells_bhp_input_well_data

post_wells_bhp_input_well_data_bulk

put_wells_bhp_input_well_data_well_data_id

delete_wells_bhp_input_well_data_well_data_id

put_wells_bhp_input_well_data_well_data_id_gas_lift_data

put_wells_bhp_input_well_data_well_data_id_well_data_casing_pipe_number

delete_wells_bhp_input_well_data_well_data_id_well_data_casing_pipe_number

put_wells_bhp_input_well_data_well_data_id_well_data_tubing_pipe_number

delete_wells_bhp_input_well_data_well_data_id_well_data_tubing_pipe_number

post_wells_bhp_input_well_deviation_survey

put_wells_bhp_inputs

patch_wells_bhp_inputs

patch_wells_bhp_inputs_no_deviation_survey

put_wells_bhp_tuning_parameters

post_wells_bhp_well_data_default_status

post_wells_bulk

get_wells_bulk_gas_lift_optimizer_results

patch_wells_bulk_gas_lift_optimizer_results

patch_wells_bulk_run_current_ipr_vlp

patch_wells_bulk_run_gas_lift_optimizer

patch_wells_bulk_run_gradient

post_wells_copy_wells