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": "06de2b55-223b-4deb-802e-3a8d6bdee37b", "Asset": { "AssetId": "080dcc9b-1fbd-4fd2-9ce3-c581b1e88489", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "cf345dfb-f57e-4dc6-be4c-e8b876e3f767", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "ff6b8f9d-7554-42d6-924a-032ca6a340f0", "CreateDate": "2025-07-19T02:58:18.8299072-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T02:58:18.8299072-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "5799b136-57a0-4c50-8afb-030b00115c9c", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-19T02:58:18.8299072-07:00", "MeasurementValueNeededDate": "2025-07-19T02:58:18.8299072-07:00", "SourceSystemId": "sample string 3", "CompanyId": "e63a7de9-78e3-4899-93f3-b9673c2001fe", "CreateDate": "2025-07-19T02:58:18.8299072-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T02:58:18.8299072-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "4fa69277-08cc-4ad3-aca8-8575bc331ca2", "EffectiveDate": "2025-07-19T02:58:18.8299072-07:00", "StateType": { "StateTypeId": "e03d08cf-f733-41dc-8ea7-8975392c8d4f", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "cf345dfb-f57e-4dc6-be4c-e8b876e3f767", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "ff6b8f9d-7554-42d6-924a-032ca6a340f0", "CreateDate": "2025-07-19T02:58:18.8299072-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T02:58:18.8299072-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "7607cf7e-60ea-40bb-b821-84cdb5fd405f", "CreateDate": "2025-07-19T02:58:18.8299072-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T02:58:18.8299072-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "6ceb1314-5bbe-4afb-b8e4-1c62e4e3af5c", "CreateDate": "2025-07-19T02:58:18.8299072-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-19T02:58:18.8299072-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "a0cd4d0f-e362-47eb-bf13-d75e2b0ff968", "EffectiveDate": "2025-07-19T02:58:18.8299072-07:00", "StatusType": { "StatusTypeId": "1d6308a5-27c1-4872-8726-a55d6195c5e0", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "cf345dfb-f57e-4dc6-be4c-e8b876e3f767", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "ff6b8f9d-7554-42d6-924a-032ca6a340f0", "CreateDate": "2025-07-19T02:58:18.8299072-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T02:58:18.8299072-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "3f8cb639-53e8-4cb1-b7b7-04961e48f0c9", "CreateDate": "2025-07-19T02:58:18.8299072-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-19T02:58:18.8299072-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "ca8afe46-5468-474b-9695-a05b93ceddd7", "CreateDate": "2025-07-19T02:58:18.8299072-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-19T02:58:18.8299072-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-07-19T02:58:18.8299072-07:00", "MeasurementValueNeededDate": "2025-07-19T02:58:18.8299072-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "667139eb-8597-41f2-a581-a8ce5698f36b", "CreateDate": "2025-07-19T02:58:18.8299072-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T02:58:18.8299072-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2025-07-19T02:58:18.8299072-07:00", "WellPurposeType": { "WellPurposeTypeId": "b9e9900a-562a-4120-9a8f-c454f7cb4c53", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "83f6739d-81fd-41f9-adda-2513c781c43e", "CreateDate": "2025-07-19T02:58:18.8299072-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-19T02:58:18.8299072-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "4da3afdb-702b-43f0-a80a-1e7b7dafeffc", "CreateDate": "2025-07-19T02:58:18.8299072-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-19T02:58:18.8299072-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": "916cb39e-93e3-47fa-a22a-a2087b0d8f16", "Asset": { "AssetId": "79d2c6a7-2cc1-4c07-b3f2-4cb74fb70346", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "ec70e750-0c74-4c84-aefb-a8381cb5967e", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "1d80ff5b-1d71-4134-80fc-3d63ec24f24d", "CreateDate": "2025-07-19T02:58:18.8299072-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T02:58:18.8299072-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "670b0444-159a-405d-9e2b-0fac75110509", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-19T02:58:18.8299072-07:00", "MeasurementValueNeededDate": "2025-07-19T02:58:18.8299072-07:00", "SourceSystemId": "sample string 3", "CompanyId": "e604959e-d589-4cb3-8c84-19f3915907ff", "CreateDate": "2025-07-19T02:58:18.8299072-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T02:58:18.8299072-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "1f5db7b3-4684-4f6c-a0e0-067546f2b83b", "EffectiveDate": "2025-07-19T02:58:18.8299072-07:00", "StateType": { "StateTypeId": "10cec866-f6fb-4ffe-922f-5f722cf6436d", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "ec70e750-0c74-4c84-aefb-a8381cb5967e", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "1d80ff5b-1d71-4134-80fc-3d63ec24f24d", "CreateDate": "2025-07-19T02:58:18.8299072-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T02:58:18.8299072-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "c8ce3fd4-c414-4255-a98f-7c9118669e79", "CreateDate": "2025-07-19T02:58:18.8299072-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T02:58:18.8299072-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "4294b991-e69f-4c3f-8c2b-0c68b952eb74", "CreateDate": "2025-07-19T02:58:18.8299072-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-19T02:58:18.8299072-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "0f1ec9d1-abe3-491b-875c-a6d456045d70", "EffectiveDate": "2025-07-19T02:58:18.8299072-07:00", "StatusType": { "StatusTypeId": "b9b1a831-bae9-44b9-b7f9-6c5ed6d80eb1", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "ec70e750-0c74-4c84-aefb-a8381cb5967e", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "1d80ff5b-1d71-4134-80fc-3d63ec24f24d", "CreateDate": "2025-07-19T02:58:18.8299072-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T02:58:18.8299072-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "abede478-aff5-4eee-ad79-4974ebfc7a43", "CreateDate": "2025-07-19T02:58:18.8299072-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-19T02:58:18.8299072-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "3264536c-76a5-493d-8627-189647c25d72", "CreateDate": "2025-07-19T02:58:18.8299072-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-19T02:58:18.8299072-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-07-19T02:58:18.8299072-07:00", "MeasurementValueNeededDate": "2025-07-19T02:58:18.8299072-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "5daf0620-1c49-4c02-9d75-06d46bcf1a0e", "CreateDate": "2025-07-19T02:58:18.8299072-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T02:58:18.8299072-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2025-07-19T02:58:18.8299072-07:00", "WellPurposeType": { "WellPurposeTypeId": "9cd3f7ca-d068-4543-8eca-a2c2c0ad27dc", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "efd04004-66bc-4145-86d5-a82655cfda73", "CreateDate": "2025-07-19T02:58:18.8299072-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-19T02:58:18.8299072-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "19d82118-d384-4ad9-b732-08bc0db4f6f1", "CreateDate": "2025-07-19T02:58:18.8299072-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-19T02:58:18.8299072-07:00", "LastModifiedUser": "sample string 4" }, "Total": 1, "Message": "sample string 1" }