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": "321753d6-46ac-4ab9-ac92-c5f1fc99cdf3", "Asset": { "AssetId": "d636102b-db7c-401e-82b9-5ccfa798b847", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "56abcad0-20bd-474b-831d-0c6d07385e22", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "2e3e7211-348a-48b1-b927-9811cc8fe1f6", "CreateDate": "2024-04-28T20:44:45.9793365-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T20:44:45.9793365-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "f9766369-789a-453d-b56a-94c619f25123", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-28T20:44:45.9793365-07:00", "MeasurementValueNeededDate": "2024-04-28T20:44:45.9793365-07:00", "SourceSystemId": "sample string 3", "CompanyId": "01f0a029-e5a2-476d-b2b0-f12d80529a78", "CreateDate": "2024-04-28T20:44:45.9793365-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T20:44:45.9793365-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "818b8665-fcb4-4dc2-8cc2-64ba3a044230", "EffectiveDate": "2024-04-28T20:44:45.9793365-07:00", "StateType": { "StateTypeId": "99ec20f7-929b-4da8-8926-2705fca19366", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "56abcad0-20bd-474b-831d-0c6d07385e22", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "2e3e7211-348a-48b1-b927-9811cc8fe1f6", "CreateDate": "2024-04-28T20:44:45.9793365-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T20:44:45.9793365-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "49f83b1e-adb0-4a8c-bf11-e3a388492a63", "CreateDate": "2024-04-28T20:44:45.9793365-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T20:44:45.9793365-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "75c4d99c-d2ce-4a39-a5f9-c2c758052a36", "CreateDate": "2024-04-28T20:44:45.9793365-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T20:44:45.9793365-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "f101035c-d82c-4e80-874f-f70c1d943fb3", "EffectiveDate": "2024-04-28T20:44:45.9793365-07:00", "StatusType": { "StatusTypeId": "8893644b-5f51-4f7a-afba-55b2323ba930", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "56abcad0-20bd-474b-831d-0c6d07385e22", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "2e3e7211-348a-48b1-b927-9811cc8fe1f6", "CreateDate": "2024-04-28T20:44:45.9793365-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T20:44:45.9793365-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "43295c6f-6687-4260-bcda-ace2e31e726d", "CreateDate": "2024-04-28T20:44:45.9793365-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T20:44:45.9793365-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "582d3e36-d11a-4c97-a081-2717904e5224", "CreateDate": "2024-04-28T20:44:45.9793365-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T20:44:45.9793365-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-04-28T20:44:45.9793365-07:00", "MeasurementValueNeededDate": "2024-04-28T20:44:45.9793365-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "0ec8c273-b408-45d7-bd69-43e193c7e014", "CreateDate": "2024-04-28T20:44:45.9793365-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T20:44:45.9793365-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2024-04-28T20:44:45.9793365-07:00", "WellPurposeType": { "WellPurposeTypeId": "9daf723b-2c9b-4b45-a5c6-7eb5bfb07df7", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "8477ec58-2820-42a4-97cf-b0554d340758", "CreateDate": "2024-04-28T20:44:45.9793365-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T20:44:45.9793365-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "9651b3cf-e183-404d-87c6-ebe4a2c2e81e", "CreateDate": "2024-04-28T20:44:45.9793365-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T20:44:45.9793365-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": "b444c846-8ac1-4813-b8d9-e33a3d6a4e6f", "Asset": { "AssetId": "48418a34-a4cd-4405-9bd0-61c8cbdee939", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "2102cd45-4489-4def-bd57-eac489d36585", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "5d5332e8-4d94-4397-83d2-d9265f130b37", "CreateDate": "2024-04-28T20:44:45.9793365-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T20:44:45.9793365-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "0a6918d4-b78e-42e0-98a6-f4a7a4d8a80d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-28T20:44:45.9793365-07:00", "MeasurementValueNeededDate": "2024-04-28T20:44:45.9793365-07:00", "SourceSystemId": "sample string 3", "CompanyId": "548d9e34-78c3-4d92-89eb-635116c8e464", "CreateDate": "2024-04-28T20:44:45.9793365-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T20:44:45.9793365-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "84cd6b76-01e1-41a6-89d1-231c5f011f09", "EffectiveDate": "2024-04-28T20:44:45.9793365-07:00", "StateType": { "StateTypeId": "21705740-8f2a-4d27-9431-50b3d4065c9e", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "2102cd45-4489-4def-bd57-eac489d36585", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "5d5332e8-4d94-4397-83d2-d9265f130b37", "CreateDate": "2024-04-28T20:44:45.9793365-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T20:44:45.9793365-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "0e63cf3b-2b23-46a5-99c0-68ca938a6b31", "CreateDate": "2024-04-28T20:44:45.9793365-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T20:44:45.9793365-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "8a07d6de-a359-43b4-9a88-825d4047fae7", "CreateDate": "2024-04-28T20:44:45.9793365-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T20:44:45.9793365-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "3b65beba-c803-4029-b5dd-6fedff9db03c", "EffectiveDate": "2024-04-28T20:44:45.9793365-07:00", "StatusType": { "StatusTypeId": "4999624a-e17d-483a-b53e-b376c42d478f", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "2102cd45-4489-4def-bd57-eac489d36585", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "5d5332e8-4d94-4397-83d2-d9265f130b37", "CreateDate": "2024-04-28T20:44:45.9793365-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T20:44:45.9793365-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "ca757350-51b9-457e-8efe-d8901d93c772", "CreateDate": "2024-04-28T20:44:45.9793365-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T20:44:45.9793365-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "e51a2490-2b81-488f-bd0c-26088ddbd683", "CreateDate": "2024-04-28T20:44:45.9793365-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T20:44:45.9793365-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-04-28T20:44:45.9793365-07:00", "MeasurementValueNeededDate": "2024-04-28T20:44:45.9793365-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "ff5fb9ac-2e77-489e-b213-cd70f0e361c8", "CreateDate": "2024-04-28T20:44:45.9793365-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T20:44:45.9793365-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2024-04-28T20:44:45.9793365-07:00", "WellPurposeType": { "WellPurposeTypeId": "10d31d0c-2c80-42aa-8452-ef40d4204b88", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "8758d925-38d5-422e-9081-56b61178df69", "CreateDate": "2024-04-28T20:44:45.9793365-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T20:44:45.9793365-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "b54b810f-6ce1-4393-a0c0-8ba2cf0448c8", "CreateDate": "2024-04-28T20:44:45.9793365-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T20:44:45.9793365-07:00", "LastModifiedUser": "sample string 4" }, "Total": 1, "Message": "sample string 1" }