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": "86de41b4-4e54-4287-873f-9a02550b293d", "Asset": { "AssetId": "17055c10-e3d5-4be8-8365-edcd795e5cbd", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "b6868676-ae1f-40a1-9691-92b0a1d29f82", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "3e07be66-c54d-4f24-8abb-b8d2e22f984e", "CreateDate": "2025-06-02T15:28:42.2410944-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:28:42.2410944-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "e1728824-8ac5-401a-a93e-1e9b163665df", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-02T15:28:42.2410944-07:00", "MeasurementValueNeededDate": "2025-06-02T15:28:42.2410944-07:00", "SourceSystemId": "sample string 3", "CompanyId": "1131e1f5-03c6-4441-bc2f-bb88b87c8bfd", "CreateDate": "2025-06-02T15:28:42.2410944-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T15:28:42.2410944-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "4774debe-cb08-4946-a18c-632c57b052ac", "EffectiveDate": "2025-06-02T15:28:42.2410944-07:00", "StateType": { "StateTypeId": "9e504437-6ec9-4c76-8947-87f44233d5d5", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "b6868676-ae1f-40a1-9691-92b0a1d29f82", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "3e07be66-c54d-4f24-8abb-b8d2e22f984e", "CreateDate": "2025-06-02T15:28:42.2410944-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:28:42.2410944-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "e123410f-ade3-461e-848b-fe7bd5e7c40a", "CreateDate": "2025-06-02T15:28:42.2410944-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T15:28:42.2410944-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "802633ca-caac-4851-b00a-bcb57cde3ea2", "CreateDate": "2025-06-02T15:28:42.2410944-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-02T15:28:42.2410944-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "5251ed7a-6525-447a-b48b-1ef5496fc977", "EffectiveDate": "2025-06-02T15:28:42.2410944-07:00", "StatusType": { "StatusTypeId": "43ef47a3-197d-4bf1-8b8a-01faf3053c50", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "b6868676-ae1f-40a1-9691-92b0a1d29f82", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "3e07be66-c54d-4f24-8abb-b8d2e22f984e", "CreateDate": "2025-06-02T15:28:42.2410944-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:28:42.2410944-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "cf9013ab-28e5-45c4-bf9c-aedd5d8a21a7", "CreateDate": "2025-06-02T15:28:42.2410944-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T15:28:42.2410944-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "78f2bb8f-bc7f-4370-b0c3-a058a901814c", "CreateDate": "2025-06-02T15:28:42.2410944-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-02T15:28:42.2410944-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-06-02T15:28:42.2410944-07:00", "MeasurementValueNeededDate": "2025-06-02T15:28:42.2410944-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "02e17fd0-9a0b-4c54-8247-68b2b3e368a1", "CreateDate": "2025-06-02T15:28:42.2410944-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:28:42.2410944-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2025-06-02T15:28:42.2410944-07:00", "WellPurposeType": { "WellPurposeTypeId": "9b48afcf-a2ad-4d0c-a4be-511de4723721", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "f98ca199-e913-4244-90aa-60380e86a693", "CreateDate": "2025-06-02T15:28:42.2410944-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T15:28:42.2410944-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "fb2f7f6c-8fba-4f93-8eda-8e8049d87462", "CreateDate": "2025-06-02T15:28:42.2410944-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-02T15:28:42.2410944-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": "06f3ca8b-497b-447a-973c-88c1c36537a1", "Asset": { "AssetId": "c3a3672d-3e87-4503-b973-d117de74193e", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "7a6943fd-12fc-4c62-94df-4b2e39e10b1c", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "b4440984-6dd4-4e93-9415-3cbb677e9e02", "CreateDate": "2025-06-02T15:28:42.2410944-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:28:42.2410944-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "dd4c9c6a-d90c-424a-8495-fa0d0ea35787", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-02T15:28:42.2410944-07:00", "MeasurementValueNeededDate": "2025-06-02T15:28:42.2410944-07:00", "SourceSystemId": "sample string 3", "CompanyId": "6566bd19-d195-4957-924f-acbddc5dd605", "CreateDate": "2025-06-02T15:28:42.2410944-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T15:28:42.2410944-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "fa7f9632-a40c-47d2-88e0-db0538251be9", "EffectiveDate": "2025-06-02T15:28:42.2410944-07:00", "StateType": { "StateTypeId": "7431859b-2524-42c1-b8e9-2c299b4f8964", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "7a6943fd-12fc-4c62-94df-4b2e39e10b1c", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "b4440984-6dd4-4e93-9415-3cbb677e9e02", "CreateDate": "2025-06-02T15:28:42.2410944-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:28:42.2410944-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "6610eac8-641e-4b0d-9e19-d068b69b6f98", "CreateDate": "2025-06-02T15:28:42.2410944-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T15:28:42.2410944-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "9d2d3c9a-4322-423f-a390-a5b7d5ecaf97", "CreateDate": "2025-06-02T15:28:42.2410944-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-02T15:28:42.2410944-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "f54456f0-b993-4fb8-9438-e985a05be879", "EffectiveDate": "2025-06-02T15:28:42.2410944-07:00", "StatusType": { "StatusTypeId": "412ab82d-8f89-4e54-bdb5-ef5e5922eb95", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "7a6943fd-12fc-4c62-94df-4b2e39e10b1c", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "b4440984-6dd4-4e93-9415-3cbb677e9e02", "CreateDate": "2025-06-02T15:28:42.2410944-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:28:42.2410944-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "d25472b1-f131-4734-933f-5ddfe04f4389", "CreateDate": "2025-06-02T15:28:42.2410944-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T15:28:42.2410944-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "839e32a0-0bbe-48e3-8fde-11535570ef99", "CreateDate": "2025-06-02T15:28:42.2410944-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-02T15:28:42.2410944-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-06-02T15:28:42.2410944-07:00", "MeasurementValueNeededDate": "2025-06-02T15:28:42.2410944-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "166d09e3-db92-4f15-aa48-e66ccc778169", "CreateDate": "2025-06-02T15:28:42.2410944-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:28:42.2410944-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2025-06-02T15:28:42.2410944-07:00", "WellPurposeType": { "WellPurposeTypeId": "37584df8-52ae-4ffb-b6e9-16382be515b7", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "95e53576-1a91-4826-a5dc-06c0f4c98bae", "CreateDate": "2025-06-02T15:28:42.2410944-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T15:28:42.2410944-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "78e01277-20d8-4a1f-b70d-a683bd951c2e", "CreateDate": "2025-06-02T15:28:42.2410944-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-02T15:28:42.2410944-07:00", "LastModifiedUser": "sample string 4" }, "Total": 1, "Message": "sample string 1" }