Whitson+

Methods (245)

• get_auto_forecasts_auto_forecast_id

  read

  Get all info of Auto-Forecast setting with auto_forecast_id

• put_auto_forecasts_auto_forecast_id_autofit

  write

  Autofit all wells in a Auto-Forecast with auto_forecast_id

• patch_auto_forecasts_auto_forecast_id_monthly_rates

  write

  Export monthly DCA rates for all three phases for an Auto-Forecast.

• patch_auto_forecasts_auto_forecast_id_tables

  write

  Return the Auto-Forecast export as JSON equivalent to the Excel export.

• get_fields

  read

  Get the complete list of all fields.

• get_fields_field_id_projects

  read

  Get the complete list of all projects under a field.

• post_fields_field_id_projects

  unknown

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

• get_mass_fluid_data

  read

  Get an array with latest fluid data for all wells.

• get_mass_fluid_data_paginated

  read

  Get paginated mass fluid data for wells.

• 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

• 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.

• get_multi_well_gas_lift_opt_multi_well_gas_lift_id_run

  read

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

• get_multi_well_gas_lift_opt_multi_well_gas_lift_id_settings

  read

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

• put_multi_well_gas_lift_opt_multi_well_gas_lift_id_settings

  write

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

• get_old_wells_paginated

  read

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

• get_processes

  read

  Get list of all processes.

• post_processes

  unknown

  Upload new process.

• put_processes_process_id

  write

  Edit a process.

• delete_processes_process_id

  write

  Delete a process.

• post_projects_multi_well_gas_lift_opt

  unknown

  Add a new Multi Well Gas Lift Optimizer in an area

• delete_projects_multi_well_gas_lift_opt_multi_well_gas_lift_id

  write

  Delete a multi well gas lift optimizer project

• post_projects_multi_well_gas_lift_opt_areas

  unknown

  Add new Multi Well Gas Lift Area in a project

• 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

• get_projects_project_id_max_production_date

  read

  Get the maximum production date of all wells in a project.

• get_projects_project_id_multi_well_gas_lift_opt_autopopulate_by_compressor_group

  read

  Automatically populates the multi-well gas lift optimizer.

• 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.

• get_projects_project_id_type_well_areas

  read

  Retrieve all the type well areas in a project

• post_projects_project_id_type_well_areas

  unknown

  Create a type well area in a project

• get_projects_project_id_well_groups

  read

  Get all group tags in a project

• post_projects_project_id_well_groups

  unknown

  Create a new group tag for wells in a project

• put_projects_project_id_well_groups

  write

  Edit group tag configuration in a project

• delete_projects_project_id_well_groups

  write

  Delete group tag in a project

• get_scenario

  read

  Get a list of scenario wells.

• delete_type_well_areas_type_well_area_id

  write

  Delete a type well area

• post_type_wells

  unknown

  Create a type well in a type well area

• put_type_wells

  write

  Edit a type well configuration

• delete_type_wells

  write

  Delete a type well

• post_type_wells_saved_cases

  unknown

  Uploads Type Well DCA cases to the database

• patch_type_wells_saved_cases

  write

  Retrieves all Type Well DCA saved cases for the given type well ids

• delete_type_wells_saved_cases

  write

  Deletes Type Well DCA saved cases from the database

• get_well_monitoring_well_id_common_process_conversion

  read

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

• get_well_monitoring_well_id_composition_tracking

  read

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

• get_well_monitoring_well_id_separator_oil_shrinkage

  read

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

• get_wells

  read

  Get a list of wells.

• post_wells

  unknown

  Upload a new well.

• patch_wells

  write

  Conviniently update partial info to many wells (header, completion, etc.).

• get_wells_active_production_data

  read

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

• patch_wells_arta_interpretations

  write

  Get classical analytical rta interpretation for provided well ids.

• post_wells_autofit_multiphase_fmb

  unknown

  Perform MFMB autofit for multiple wells, with optional post-fit MFMB calculation using pressure

• post_wells_autofit_multiphase_fmb_with_pavg_criteria

  unknown

  Perform MFMB autofit for multiple wells, with optional post-fit MFMB calculation using pressure

• get_wells_autofit_rta

  read

  Launch Numerical RTA autofit for multiple wells.

• get_wells_bhp_calculation

  read

  Get BHP calculation in bulk.

• get_wells_bhp_calculation_status

  read

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

• get_wells_bhp_calculation_with_gauge_data

  read

  Get BHP calculation and gauge data in bulk.

• patch_wells_bhp_input_well_data

  write

  Fetch WellData for multiple well IDs in a single query (bulk endpoint).

• post_wells_bhp_input_well_data_bulk

  unknown

  Bulk create/update wellbore configurations for many wells.

• put_wells_bhp_input_well_data_well_data_id

  write

  Edit a WellData object to a BHPInput.

• delete_wells_bhp_input_well_data_well_data_id

  write

  Delete a WellData object to a BHPInput.

• put_wells_bhp_input_well_data_well_data_id_gas_lift_data

  write

  Edit a list of gas lift valves to a WellData.

• put_wells_bhp_input_well_data_well_data_id_well_data_casing_pipe_number

  write

  Edit a WellDataCasing object to a WellData.

• delete_wells_bhp_input_well_data_well_data_id_well_data_casing_pipe_number

  write

  Delete a WellDataCasing object to a WellData.

• put_wells_bhp_input_well_data_well_data_id_well_data_tubing_pipe_number

  write

  Edit a WellDataTubing object to a WellData.

• delete_wells_bhp_input_well_data_well_data_id_well_data_tubing_pipe_number

  write

  Delete a WellDataTubing object to a WellData.

• post_wells_bhp_input_well_deviation_survey

  unknown

  Bulk upload/edit well deviation surveys for multiple wells.

• put_wells_bhp_inputs

  write

  ### Body example

• patch_wells_bhp_inputs

  write

  Get BHP input for multiple wells.

• patch_wells_bhp_inputs_no_deviation_survey

  write

  Get BHP input for multiple wells.

• put_wells_bhp_tuning_parameters

  write

  Edit the BHP tuning parameters for many wells.

• post_wells_bhp_well_data_default_status

  read

  post_wells_bhp_well_data_default_status

• post_wells_bulk

  unknown

  Bulk create new wells.

• get_wells_bulk_gas_lift_optimizer_results

  read

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

• patch_wells_bulk_gas_lift_optimizer_results

  write

  Get gas lift optimizer results for selected wells.

• patch_wells_bulk_run_current_ipr_vlp

  write

  Batch run ipr vlp for wells with IDs using last production data or average production data.

• patch_wells_bulk_run_gas_lift_optimizer

  write

  Run gas lift optimizer for selected wells.

• patch_wells_bulk_run_gradient

  write

  Run gradient for selected wells.

• post_wells_copy_wells

  unknown

  Copy multiple wells to an existing project.

• post_wells_custom_attributes_bulk

  unknown

  Upsert one {well_id, attribute_name, value} tuple per list item.

• patch_wells_custom_attributes_bulk

  write

  Retrieve current custom-attribute values for multiple wells.

• delete_wells_custom_attributes_bulk

  write

  Bulk deletion of custom-attribute values; ignores missing targets.

• post_wells_data_fields

  read

  Get a list of wells by their IDs with selected attributes.

• patch_wells_dca

  write

  Retrieves all well DCAs for the given well ids

• get_wells_dca_daily_rates

  read

  Export daily DCA rates for all three phases for a list of well_ids.

• get_wells_dca_monthly_rates

  read

  Export monthly DCA rates for all three phases for a list of well_ids.

• post_wells_dca_saved_case

  unknown

  post_wells_dca_saved_case

• patch_wells_dca_saved_cases

  write

  Retrieves all well DCA saved cases for the given well ids

• get_wells_dca_saved_cases_daily_rates

  read

  Export daily DCA rates for saved cases for a list of well_ids.

• get_wells_dca_saved_cases_monthly_rates

  read

  Export monthly DCA rates for saved cases for a list of well_ids.

• get_wells_fat_gas_rate

  read

  Bulk‐retrieve fat gas rate series (`common_process_conversion`

• put_wells_forecast_inputs

  write

  Edit Multiple Forecast Inputs

• put_wells_gradient_cases

  write

  Edit gradient cases in bulk.

• patch_wells_gradient_cases

  write

  Get gradient cases of selected wells

• put_wells_gradient_cases_gradient_case_id

  write

  Edit a gradient case.

• delete_wells_gradient_cases_gradient_case_id

  write

  Delete a gradient case.

• get_wells_history_matching

  read

  Get a list of history matching object.

• get_wells_history_matching_input

  read

  Get a list of history matching inputs.

• put_wells_history_matching_input

  write

  Edit history matching inputs for many wells.

• post_wells_latest_date_gradient_cases

  unknown

  post_wells_latest_date_gradient_cases

• get_wells_light

  read

  get_wells_light

• patch_wells_mass_export_custom_results

  write

  Retrieve certain data for wells, equivalent to well exports in Whitson+.

• get_wells_monthly_production_data

  read

  Get the monthly production records of wells in bulk

• post_wells_monthly_production_data

  unknown

  Upload monthly production data in bulk.

• delete_wells_monthly_production_data

  write

  Delete monthly production data for the well WELL_ID.

• get_wells_multi_well_arta_autofit_phase

  read

  Autofit straight line and TELF to existing production data

• get_wells_multi_well_fractional_arta_autofit_phase

  read

  Autofit straight line to existing production data

• get_wells_multiphase_fmb_interpretations

  read

  Get mutiphase fmb interpretation for wells in bulk

• get_wells_multiphase_fmb_pavg

  read

  Get calculated MultiphaseFMB pressure average in bulk

• patch_wells_multiphase_fmb_pavg

  write

  Get calculated MultiphaseFMB pressure average for selected wells with time filters

• get_wells_new_well_input_status

  read

  Get the new well input status of a well

• patch_wells_nodal_ipr_input

  write

  Get IPR input used in nodal_analysis for wells specified.

• put_wells_nrta_weight_factors

  write

  Edit Numerical RTA weight factors for many wells.

• patch_wells_pi_from_ipr

  write

  Set initial reservoir pressure for wells based on IPR

• get_wells_pnr

  read

  get_wells_pnr

• get_wells_production_data

  read

  Get the production records of wells in bulk

• post_wells_production_data

  unknown

  Upload production data in bulk.

• delete_wells_production_data

  write

  Delete exactly the production timestamps given for each well.

• patch_wells_production_data_dates

  write

  Expects JSON:

• get_wells_production_data_comments

  read

  Get production comments of wells in bulk

• post_wells_production_data_comments

  unknown

  Upload production comments in bulk

• patch_wells_pvt_calcs

  write

  Get PVT-calculation results for multiple wells (JSON payload).

• patch_wells_pvt_calculation_status

  write

  Get PVT calculation status for a list of well_ids.

• get_wells_pwf_active

  read

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

• get_wells_pwf_custom

  read

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

• get_wells_rta_autofit_rms

  read

  Get Numerical RTA autofit RMS for many wells.

• get_wells_rta_calc

  read

  Get RTA Calcs for many wells.

• get_wells_rta_input

  read

  Get the Numerical RTA input for many wells.

• put_wells_rta_input

  write

  Edit RTA input for many wells.

• get_wells_run_bhp_calculation

  read

  Run BHP calculations for many wells (excluding scenario).

• get_wells_run_composition_calc

  read

  Run PVT calculations for many wells (excluding scenarios).

• get_wells_run_history_matching

  read

  Launch Numerical Model calculation on a list of wells.

• post_wells_run_multiphase_fmb

  unknown

  Run an Multiphase FMB PWF and/or Multiphase FMB PAvg for many wells.

• get_wells_run_pvt_calcs

  read

  Run PVT calculations for many wells (excluding scenarios).

• get_wells_run_rta

  read

  Run numerical RTA on a list of wells.

• post_wells_run_sales_products

  unknown

  Bulk‐trigger a new sales products calculation for each well.

• get_wells_run_well_monitoring

  read

  Run well monitoring calculations for multiple wells.

• put_wells_sales_products_input

  write

  Bulk upload / update Sales-Products inputs

• get_wells_sales_products_rates

  read

  Bulk‐retrieve only the `ngl` & `ngl_common` series for each well's latest calc.

• get_wells_sampling_advanced_id

  read

  Get sampling data for sampling ID.

• get_wells_sampling_data_id

  read

  Get sampling data for sampling ID.

• get_wells_sampling_quick_id

  read

  Get sampling data for sampling ID.

• get_wells_sampling_simplified_drygas_id

  read

  Get sampling data for sampling ID.

• put_wells_update_surface_pressure_vlp

  write

  Update surface pressure for a well.

• get_wells_well_id

  read

  Get all info of well with ID.

• put_wells_well_id

  write

  Edit a well.

• patch_wells_well_id

  write

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

• delete_wells_well_id

  write

  Delete a well.

• get_wells_well_id_active_production_data

  read

  Get the active production data for a well.

• put_wells_well_id_analytical_rta_input

  write

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

• get_wells_well_id_approximate_gor_init

  read

  Approximate initial GOR for a well based on production data.

• get_wells_well_id_arta_interpretations

  read

  Get classical analytical rta interpretation for well <WELL_ID>

• get_wells_well_id_arta_time_series

  read

  Get analytical rta time series for well <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

• 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

• get_wells_well_id_autofit_rta

  read

  Autofit Numerical RTA LFP.

• get_wells_well_id_available_custom_attributes

  read

  Get a list of available custom attributes for a well.

• get_wells_well_id_bhp_calculation

  read

  Get a BHP calculation.

• get_wells_well_id_bhp_input

  read

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

• put_wells_well_id_bhp_input

  write

  Edit a bhp input.

• get_wells_well_id_bhp_input_well_data

  read

  Get a list of WellData(wellbore config) object to a well.

• post_wells_well_id_bhp_input_well_data

  unknown

  Create a list of WellData object to a BHPInput.

• get_wells_well_id_bhp_input_well_data_well_data_casing

  read

  Get a list of WellDataCasing object to a WellData.

• post_wells_well_id_bhp_input_well_data_well_data_casing

  unknown

  Create a list of WellDataCasing object to a WellData.

• get_wells_well_id_bhp_input_well_data_well_data_tubing

  read

  Get a list of WellDataTubing object to a WellData.

• post_wells_well_id_bhp_input_well_data_well_data_tubing

  unknown

  Create a list of WellDataTubing object to a WellData.

• get_wells_well_id_bhp_input_well_deviation_survey

  read

  Get the well deviation survey data of the well.

• put_wells_well_id_bhp_input_well_deviation_survey

  write

  Get the well deviation survey data of the well.

• get_wells_well_id_bot_bot_table

  read

  Get BOT table for a well.

• get_wells_well_id_calculate_analytical_rta

  read

  Calculate analytical rta for well <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>.

• get_wells_well_id_cum_lfp

  read

  Get cumulative LFP for a well.

• get_wells_well_id_custom_attributes

  read

  Get the custom attributes of a well.

• post_wells_well_id_custom_attributes

  unknown

  Add a custom attribute to a well.

• delete_wells_well_id_custom_attributes_attribute_name

  write

  Delete a custom attribute value from a well.

• get_wells_well_id_custom_bhp_calculation

  read

  Get a Custom BHP calculation.

• get_wells_well_id_fetch_from_ipr

  read

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

• put_wells_well_id_forecast_input

  write

  Edit Forecast Input

• get_wells_well_id_fractional_arta_interpretations

  read

  Get fractional analytical rta interpretation for well <WELL_ID>

• get_wells_well_id_gas_fmb_material_balance_pseudotime

  read

  Get flow material balance time and mass rate normalized density change @ Pwf.

• get_wells_well_id_gas_lift_optimizer_cases

  read

  Get the gas lift optimizer cases of a well.

• post_wells_well_id_gas_lift_optimizer_cases

  unknown

  Create a gas lift optimizer case of a well.

• put_wells_well_id_gas_lift_optimizer_cases_gas_lift_case_id

  write

  Edit a gas lift optimizer case.

• delete_wells_well_id_gas_lift_optimizer_cases_gas_lift_case_id

  write

  Delete a gas lift optimizer case.

• get_wells_well_id_gradient_cases

  read

  Get the gradient cases of a well.

• post_wells_well_id_gradient_cases

  unknown

  Create gradient cases for a well.

• post_wells_well_id_groups_group_name

  unknown

  Add a group to a well.

• delete_wells_well_id_groups_group_name

  write

  Delete a group from a well.

• get_wells_well_id_history_matching

  read

  Get a list of history matching object.

• put_wells_well_id_history_matching_input

  write

  Edit a history matching input, toggling the include_forecast flag.

• get_wells_well_id_input_quick

  read

  Get PVT input of a well.

• put_wells_well_id_input_quick

  write

  Edit PVT input of a well.

• get_wells_well_id_input_simplified_dry_gas

  read

  Get PVT input of a well.

• put_wells_well_id_input_simplified_dry_gas

  write

  Edit PVT input of a well.

• get_wells_well_id_ipr

  read

  Get IPR data for a well.

• get_wells_well_id_last_bhp_calc_time

  read

  Get the last BHP calculation time for a well.

• get_wells_well_id_material_balance_time

  read

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

• get_wells_well_id_max_production_date

  read

  Get the maximum production date of a well.

• get_wells_well_id_multiphase_fmb_interpretations

  read

  Get mutiphase fmb interpretation for a well

• get_wells_well_id_multiphase_fmb_pavg

  read

  Get a list of calculated MultiphaseFMB pressure average for a well

• get_wells_well_id_multiphase_fmb_pwf

  read

  Get flow material balance time and mass rate normalized density change @ Pwf

• get_wells_well_id_ngl_calculation_result

  read

  Get the NGL calculation results for a well

• put_wells_well_id_ngl_efficiencies

  write

  Edit the NGL efficiencies for a well

• get_wells_well_id_pi_from_ipr

  read

  Set initial reservoir pressure for a well based on IPR

• get_wells_well_id_processes

  read

  Get PVT process for a well.

• put_wells_well_id_processes

  write

  Edit PVT process for a well.

• get_wells_well_id_production_data

  read

  Get the production records of a well.

• post_wells_well_id_production_data

  unknown

  Upload production data for <well_id>.

• put_wells_well_id_production_data

  write

  Partial upload and edit production data for <well_id>.

• delete_wells_well_id_production_data

  write

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

• delete_wells_well_id_production_data_comments

  write

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

• get_wells_well_id_pvt_input

  read

  Get PVT input of a well.

• put_wells_well_id_pvt_input

  write

  Edit PVT input of a well.

• get_wells_well_id_pwf_active

  read

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

• get_wells_well_id_rta_autofit_rms

  read

  Get Numerical RTA autofit RMS for a well.

• get_wells_well_id_rta_calc

  read

  Get RTA Calc for a well.

• get_wells_well_id_rta_input

  read

  Get the Numerical RTA input of a well.

• put_wells_well_id_rta_input

  write

  Edit an RTA input.

• put_wells_well_id_rta_lfp

  write

  put_wells_well_id_rta_lfp

• 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.

• get_wells_well_id_run_bhp_calculation

  read

  Run BHP calculations for a single well.

• get_wells_well_id_run_composition_calc

  read

  Run PVT calculation for a single well.

• patch_wells_well_id_run_gas_lift_optimizer_case

  write

  Run gas lift optimizer calculation for selected cases.

• get_wells_well_id_run_gradient

  read

  Run gradient calculation for selected cases.

• get_wells_well_id_run_history_matching

  read

  Run history matching calculation on a well.

• get_wells_well_id_run_ipr_with_date

  read

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

• get_wells_well_id_run_multiphase_fmb

  read

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

• get_wells_well_id_run_ngl_calculation

  read

  Run NGL calculation on a well

• get_wells_well_id_run_pvt_calc

  read

  Run PVT calculation for a single well.

• get_wells_well_id_run_rta

  read

  Run numerical RTA on a well.

• get_wells_well_id_run_simulated_pvt_study

  read

  Run a simulated PVT study calculation.

• patch_wells_well_id_run_vlp

  write

  Run VLP calculation for selected cases.

• get_wells_well_id_run_well_monitoring

  read

  Run well monitoring calculation for a well

• 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.

• post_wells_well_id_sampling_data

  unknown

  Upload a sampling data input. REMOVES any existing samples on the same date for the well.

• 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.

• post_wells_well_id_sampling_inputs

  unknown

  Upload a sampling data input. REMOVES any existing samples on the same date for the well.

• delete_wells_well_id_sampling_inputs_date

  write

  Delete a sampling input.

• put_wells_well_id_set_production_rate_type_rate_type

  write

  Set the production rate type of a well.

• get_wells_well_id_simulated_pvt_study

  read

  Get a simulated PVT study.

• get_wells_well_id_status

  read

  Get the data status of a well

• put_wells_well_id_vlp_case_vlp_case_id

  write

  Edit a VLP case.

• delete_wells_well_id_vlp_case_vlp_case_id

  write

  Delete a VLP case.

• get_wells_well_id_vlp_cases

  read

  Get all VLP cases of a well

• post_wells_well_id_vlp_cases

  unknown

  Post a VLP case of a well

• get_wells_well_id_well_dca_dca_export

  read

  Get Well DCA results for all three phases.

• get_wells_well_id_well_dca_saved_cases

  read

  Get a list of WellDCASavedCase object to a well.

• get_wells_paginated

  read

  Get a list of wells (result paginated).