PUT WellPurposes
Updates the given well purpose.
Request Information
URI Parameters
None.
Body Parameters
Well purpose to be updated
WellPurposeName | 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": "f14b3409-1128-485c-b467-b1947eb6f056", "Asset": { "AssetId": "ac21f096-65f8-4195-9b7a-185355ec1b4d", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "0773c0f6-3482-4022-a7e5-5829302003bc", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "cdf3c81d-a440-4833-a49f-ac5f7ca9e85d", "CreateDate": "2025-06-27T07:40:18.1578417-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T07:40:18.1578417-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "25686195-d597-4019-8749-fcaf034aca9b", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-27T07:40:18.1578417-07:00", "MeasurementValueNeededDate": "2025-06-27T07:40:18.1578417-07:00", "SourceSystemId": "sample string 3", "CompanyId": "181a5330-fbbd-415e-9818-761ae73858b3", "CreateDate": "2025-06-27T07:40:18.1578417-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T07:40:18.1578417-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "302e7923-c00a-4f96-953b-0fc23a2ac6e7", "EffectiveDate": "2025-06-27T07:40:18.1578417-07:00", "StateType": { "StateTypeId": "2fda6518-3724-4b54-9641-a8d1caf333c8", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "0773c0f6-3482-4022-a7e5-5829302003bc", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "cdf3c81d-a440-4833-a49f-ac5f7ca9e85d", "CreateDate": "2025-06-27T07:40:18.1578417-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T07:40:18.1578417-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "936f50c3-558a-42f4-b274-68ed87582f71", "CreateDate": "2025-06-27T07:40:18.1578417-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T07:40:18.1578417-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "750624e5-d6d6-42d1-8a5f-afc039cbde09", "CreateDate": "2025-06-27T07:40:18.1578417-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-27T07:40:18.1578417-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "d651f5f4-8ea1-4d8d-aefd-623a5ac0df01", "EffectiveDate": "2025-06-27T07:40:18.1578417-07:00", "StatusType": { "StatusTypeId": "310b859d-17ce-4418-a6d1-4f3c75743cc6", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "0773c0f6-3482-4022-a7e5-5829302003bc", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "cdf3c81d-a440-4833-a49f-ac5f7ca9e85d", "CreateDate": "2025-06-27T07:40:18.1578417-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T07:40:18.1578417-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "04546288-447d-4d9e-ba4f-f743679c66a7", "CreateDate": "2025-06-27T07:40:18.1578417-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-27T07:40:18.1578417-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "df86123c-251a-4f31-ac16-63db3aee84df", "CreateDate": "2025-06-27T07:40:18.1578417-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-27T07:40:18.1578417-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-06-27T07:40:18.1578417-07:00", "MeasurementValueNeededDate": "2025-06-27T07:40:18.1578417-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "85f3fb23-8728-4b3c-b5ae-957f05ce61ca", "CreateDate": "2025-06-27T07:40:18.1578417-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T07:40:18.1578417-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2025-06-27T07:40:18.1578417-07:00", "WellPurposeType": { "WellPurposeTypeId": "2daf8bd7-1d99-45d5-a074-91fd6134084b", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "8223b6e1-7eaa-41dc-aaf8-a4ee2aadab08", "CreateDate": "2025-06-27T07:40:18.1578417-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-27T07:40:18.1578417-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "6b432ce5-96d0-4c6c-a9cd-1b45a9474322", "CreateDate": "2025-06-27T07:40:18.1578417-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-27T07:40:18.1578417-07: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": "924f880e-7f10-4dbf-b874-c719849c3009", "Asset": { "AssetId": "e16fd539-9e8d-492c-b4cf-6b608d7281cb", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "ec810ee0-4bf2-4f07-a27d-90798e42b1bb", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "33baba34-7273-43e9-9a2d-1a3d04451d6c", "CreateDate": "2025-06-27T07:40:18.1578417-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T07:40:18.1578417-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "57194ddf-bbb1-4963-8863-59c4a259fce4", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-27T07:40:18.1578417-07:00", "MeasurementValueNeededDate": "2025-06-27T07:40:18.1578417-07:00", "SourceSystemId": "sample string 3", "CompanyId": "453476a1-7684-4341-ad30-fb1a7f6116c0", "CreateDate": "2025-06-27T07:40:18.1578417-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T07:40:18.1578417-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "81fb6197-f786-4a3f-8db0-54e33f7f5613", "EffectiveDate": "2025-06-27T07:40:18.1578417-07:00", "StateType": { "StateTypeId": "c0722560-e7d8-48f8-8277-63b1b09bd278", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "ec810ee0-4bf2-4f07-a27d-90798e42b1bb", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "33baba34-7273-43e9-9a2d-1a3d04451d6c", "CreateDate": "2025-06-27T07:40:18.1578417-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T07:40:18.1578417-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "2cee3ba7-ccd6-46e8-947b-286c2495e590", "CreateDate": "2025-06-27T07:40:18.1578417-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T07:40:18.1578417-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "362f0893-0b16-4100-bb6f-48abde5a52f6", "CreateDate": "2025-06-27T07:40:18.1578417-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-27T07:40:18.1578417-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "a0127747-e926-4966-8eb0-439a834acbf5", "EffectiveDate": "2025-06-27T07:40:18.1578417-07:00", "StatusType": { "StatusTypeId": "f9300b5f-ad16-48d1-a8e4-2fe8cd2f9be7", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "ec810ee0-4bf2-4f07-a27d-90798e42b1bb", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "33baba34-7273-43e9-9a2d-1a3d04451d6c", "CreateDate": "2025-06-27T07:40:18.1578417-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T07:40:18.1578417-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "f4f4aece-2df0-457d-ae43-a4b1a51ed60e", "CreateDate": "2025-06-27T07:40:18.1578417-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-27T07:40:18.1578417-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "43484149-6853-4894-82b6-067ba3e7bb64", "CreateDate": "2025-06-27T07:40:18.1578417-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-27T07:40:18.1578417-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-06-27T07:40:18.1578417-07:00", "MeasurementValueNeededDate": "2025-06-27T07:40:18.1578417-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "da42448a-6524-4a55-949d-042c9cfab41f", "CreateDate": "2025-06-27T07:40:18.1578417-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T07:40:18.1578417-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2025-06-27T07:40:18.1578417-07:00", "WellPurposeType": { "WellPurposeTypeId": "2913222e-ece3-4563-aabf-15748c078c5e", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "b586da23-7b95-4e89-980e-3ee3f00c47d1", "CreateDate": "2025-06-27T07:40:18.1578417-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-27T07:40:18.1578417-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "81ecdfdb-e0c0-4477-b8a5-e99dd2fa7768", "CreateDate": "2025-06-27T07:40:18.1578417-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-27T07:40:18.1578417-07:00", "LastModifiedUser": "sample string 4" }, "Total": 1, "Message": "sample string 1" }