V320

Hi dear users of the whitson+ external API,

We will promote External API v 3.2.0 to production rolling out Wed 21 → Fri 30 May 2025.

Most additions are backward-compatible, but a few changes will break existing integrations unless you update your calls.

BREAKING CHANGES (ACTION REQUIRED)

1 - Custom Attributes Schema Changes

Custom attributes were previously embedded as an object (key-value map). They are now replaced by custom_attribute_values, an array with standardized attribute_id references. Several endpoints have removed or changed custom_attributes as a result.

Change in response/request structure from custom_attribute property.

  • GET /api-external/v1/fields

  • GET /api-external/v1/fields/{field_id}/projects

  • GET /api-external/v1/wells/{well_id}/available_custom_attributes

Remove custom_attribute or changed into custom_attribute_values with an updated schema

  • GET /api-external/v1/wells
  • GET /api-external/v1/wells_paginated
  • GET /api-external/v1/old_wells_paginated
  • GET /api-external/v1/wells/{well_id}
  • GET /api-external/v1/wells/{well_id}/custom_attributes
  • DELETE /api-external/v1/wells/{well_id}/custom_attributes/{attribute_name}
  • PUT /api-external/v1/wells/{well_id}
  • POST /api-external/v1/wells/data_fields
  • POST /api-external/v1/wells/{well_id}/custom_attributes

2 - DCA Model Enhancement & Cleanup

Exactly one saved-case family per DCA segment.

  • Accepted columns (choose one): well_dca_saved_case_id | well_multi_dca_id | type_well_dca_saved_case_id | pnr_dca_saved_case_id | group_forecast_dca_saved_case_id
  • Supplying more than one returns 409 Conflict.

ID key renames

  • well_dca_id → well_dca_saved_case_id
  • type_well_dca_id → type_well_dca_saved_case_id

Automatic migration of existing objects

  • Each well_dca → well_dca_saved_case (name = "Main", is_current = true)
  • Each type_well_dca → type_well_dca_saved_case (name = "Main", is_current = true)

(No other DCA schema changes—only new optional columns added.)

NON-BREAKING ADDITIONS

  • PATCH /api-external/v1/wells/pvt_calculation_status