Skip to main content

Wells Identifiers Overview

The structure of the WellIdentifierPatchInputList can include the following properties and values.

[
	...,
	{
		"wellId": "5e272d39b78210dd2a1bd8fe", // required
				"newInfo": { // at least one of them.
					"chosenKeyID": "api14",
					"companyScope": true,
					"dataSource": "internal"
				}
	},
	...
]

Into the newInfo property, the values of each property must be:

  • chosenKeyID : 'inptID', 'api10', 'api12', 'api14', 'aries_id' or 'phdwin_id'
  • companyScope: true
  • dataSource : 'di', 'ihs', 'phdwin', 'aries', 'internal' or 'other'

If any value not listed above is sent the API will return either a FieldName or Value error.

It is worth knowing that an atomic operation would be performed for each "well-identifier" request object you send. i.e., if you send a request with chosenKeyID and dataSource properties and there are any validation issues in either of them, that well information will not be updated at all.

Apart from the types and values error described above, the validation errors returned from the response, respect the same validation rules defined in ComboCurve, they could be two:

  • A BadRequest Error with the message Missing Identifier xxxx.
    • This happens when a null chosenKeyID is specified. e.g: You want to change the chosenID and set the value of the api14, in this case if the property api14 has a null value, you will get this error.
  • A BadRequest Error with the message Collisions with xxxx, xxxx
    • This could happen for several reasons depending the scenario. Some examples could be:
      • Causing a conflict by changing the chosenID to a well that has similar dataSource and chosenID of another well.
        • Causing a conflict by changing the dataSource to a well that has similar dataSource and chosenID of another well.