PUT WellPurposes
Updates the given well purpose.
Request Information
URI Parameters
None.
Body Parameters
Well purpose to be updated
WellPurpose| Name | Description | Type | Additional information |
|---|---|---|---|
| WellPurposeId | globally unique identifier |
None. |
|
| Asset | Asset |
None. |
|
| EffectiveDate | date |
None. |
|
| WellPurposeType | WellPurposeType |
None. |
|
| SourceSystemId | string |
None. |
|
| CompanyId | globally unique identifier |
None. |
|
| CreateDate | date |
None. |
|
| CreateUser | string |
None. |
|
| LastModifiedDate | date |
None. |
|
| LastModifiedUser | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"WellPurposeId": "663c951a-4ee2-4a01-97f3-a9b5598cdc94",
"Asset": {
"AssetId": "d9d74fe2-bfcc-42fa-95ec-9e6d811c10ac",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "5a7af500-2306-4560-891f-fc46d064488a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "dd3e9227-c5b3-414b-8166-2d232a79accf",
"CreateDate": "2026-11-22T14:12:59.3319441-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:12:59.3319441-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "f95c78ac-ba58-4dd5-9ee7-5840fc1fecd6",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-22T14:12:59.3319441-08:00",
"MeasurementValueNeededDate": "2026-11-22T14:12:59.3319441-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "fa1fd6e4-5a51-4654-8c77-5f635e948f3d",
"CreateDate": "2026-11-22T14:12:59.3319441-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:12:59.3319441-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "84f5bfd3-d78d-446b-a00c-9d1c7f56cfa3",
"EffectiveDate": "2026-11-22T14:12:59.3319441-08:00",
"StateType": {
"StateTypeId": "ce3dd49c-1fd0-44cc-83dc-3752f8043a54",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "5a7af500-2306-4560-891f-fc46d064488a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "dd3e9227-c5b3-414b-8166-2d232a79accf",
"CreateDate": "2026-11-22T14:12:59.3319441-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:12:59.3319441-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "fac27d9c-8b49-45c2-a2db-4630f28e01da",
"CreateDate": "2026-11-22T14:12:59.3319441-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:12:59.3319441-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e8e86c0f-0902-4b1e-a3b8-b032bbb37b8d",
"CreateDate": "2026-11-22T14:12:59.3319441-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T14:12:59.3319441-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "317a190a-e7c8-4f25-9787-3281ecc5375d",
"EffectiveDate": "2026-11-22T14:12:59.3319441-08:00",
"StatusType": {
"StatusTypeId": "109e3902-537d-4ee8-8f1e-7cc45921f724",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "5a7af500-2306-4560-891f-fc46d064488a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "dd3e9227-c5b3-414b-8166-2d232a79accf",
"CreateDate": "2026-11-22T14:12:59.3319441-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:12:59.3319441-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "1804ba3d-af2f-4840-b96e-e4f2910a0f26",
"CreateDate": "2026-11-22T14:12:59.3319441-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-22T14:12:59.3319441-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a4e06547-9231-4f0f-9b4e-b28f81100964",
"CreateDate": "2026-11-22T14:12:59.3319441-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T14:12:59.3319441-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-22T14:12:59.3319441-08:00",
"MeasurementValueNeededDate": "2026-11-22T14:12:59.3319441-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "b6ba6952-cdd3-4981-a3ea-ba5080644856",
"CreateDate": "2026-11-22T14:12:59.3319441-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:12:59.3319441-08:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2026-11-22T14:12:59.3319441-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "049fa3b0-e623-4c5c-870a-4dc620294b65",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "5b6fb14c-798c-4d66-9b1e-10f435dca9c5",
"CreateDate": "2026-11-22T14:12:59.3319441-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-22T14:12:59.3319441-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0e4051b9-fd08-4a99-99c3-61467c301183",
"CreateDate": "2026-11-22T14:12:59.3319441-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T14:12:59.3319441-08:00",
"LastModifiedUser": "sample string 4"
}
Response Information
Resource Description
On success, the updated well purpose.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | WellPurpose |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": {
"WellPurposeId": "b86f1404-b21e-4b91-8c70-e29b982238bb",
"Asset": {
"AssetId": "e1cabc10-ed41-4f38-b059-8de423bc2561",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "918d8806-4cdc-4b10-9c47-a46a3c80afd2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a0625f7c-dc17-4bf7-9b50-7888232575dc",
"CreateDate": "2026-11-22T14:12:59.3319441-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:12:59.3319441-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "3e71290a-5cc5-444e-88cf-046abee3244f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-22T14:12:59.3319441-08:00",
"MeasurementValueNeededDate": "2026-11-22T14:12:59.3319441-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5e3a2f45-a2b8-48f6-8994-16a5b8225cf5",
"CreateDate": "2026-11-22T14:12:59.3319441-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:12:59.3319441-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "d92a0ce3-9acd-4008-83d1-7874bc3931ad",
"EffectiveDate": "2026-11-22T14:12:59.3319441-08:00",
"StateType": {
"StateTypeId": "ceb4d54a-9a6a-45f7-a0d1-b6b0d6ba11d3",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "918d8806-4cdc-4b10-9c47-a46a3c80afd2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a0625f7c-dc17-4bf7-9b50-7888232575dc",
"CreateDate": "2026-11-22T14:12:59.3319441-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:12:59.3319441-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "a3c9a2d1-c601-4929-b354-4eb3edca8df3",
"CreateDate": "2026-11-22T14:12:59.3319441-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:12:59.3319441-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1a2ae086-289f-4445-98e1-df54c42f11fc",
"CreateDate": "2026-11-22T14:12:59.3319441-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T14:12:59.3319441-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "c16bcf39-d831-488c-8f0b-819a29175e7c",
"EffectiveDate": "2026-11-22T14:12:59.3319441-08:00",
"StatusType": {
"StatusTypeId": "a4c9b510-0e31-4baf-8be6-ebcab80a07d4",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "918d8806-4cdc-4b10-9c47-a46a3c80afd2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a0625f7c-dc17-4bf7-9b50-7888232575dc",
"CreateDate": "2026-11-22T14:12:59.3319441-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:12:59.3319441-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "e2c4bfcc-55e2-4e73-b3ab-c54477fb8f07",
"CreateDate": "2026-11-22T14:12:59.3319441-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-22T14:12:59.3319441-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3846efb9-711f-48a5-a960-05cc56bf52fb",
"CreateDate": "2026-11-22T14:12:59.3319441-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T14:12:59.3319441-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-22T14:12:59.3319441-08:00",
"MeasurementValueNeededDate": "2026-11-22T14:12:59.3319441-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "f41ba8ec-50b4-4342-a284-af3759a03c6b",
"CreateDate": "2026-11-22T14:12:59.3319441-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:12:59.3319441-08:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2026-11-22T14:12:59.3319441-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "203fec47-b888-462a-a110-b9ad20985506",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "634ec130-2bc8-478a-a4c4-d871a3348797",
"CreateDate": "2026-11-22T14:12:59.3319441-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-22T14:12:59.3319441-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "93569ab5-ed3f-43d6-96f4-b09be3b4b459",
"CreateDate": "2026-11-22T14:12:59.3319441-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T14:12:59.3319441-08:00",
"LastModifiedUser": "sample string 4"
},
"Total": 1,
"Message": "sample string 1"
}