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": "960a75c8-dbea-4c9f-b2d6-889265426b2a", "Asset": { "AssetId": "c651bfc8-fd27-47c2-8008-3eebf0856126", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "dafe3eb6-48e9-4212-8942-c9e64963e33e", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "17bb9f6d-787e-4399-8b8d-b3efc863ea45", "CreateDate": "2024-04-26T18:17:49.6898408-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-26T18:17:49.6898408-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "7f0657cb-3e65-4adb-bbfd-0abdc96cd072", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-26T18:17:49.6898408-07:00", "MeasurementValueNeededDate": "2024-04-26T18:17:49.6898408-07:00", "SourceSystemId": "sample string 3", "CompanyId": "bc924129-4f8d-47d9-a2a0-7d46b0ebd030", "CreateDate": "2024-04-26T18:17:49.6898408-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T18:17:49.6898408-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "4d82dab8-4915-4ba8-8434-5f34319deaf7", "EffectiveDate": "2024-04-26T18:17:49.6898408-07:00", "StateType": { "StateTypeId": "429b7c86-f2fc-452c-99d6-be310248d7c0", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "dafe3eb6-48e9-4212-8942-c9e64963e33e", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "17bb9f6d-787e-4399-8b8d-b3efc863ea45", "CreateDate": "2024-04-26T18:17:49.6898408-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-26T18:17:49.6898408-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "0ca50d47-6f33-4e9b-8db1-5bdbfd76f72d", "CreateDate": "2024-04-26T18:17:49.6898408-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T18:17:49.6898408-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "2ad94e25-a9d6-4770-8dc1-c7d7972d50c5", "CreateDate": "2024-04-26T18:17:49.6898408-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-26T18:17:49.6898408-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "68bec292-15bb-4ae7-88a6-d503f1229f30", "EffectiveDate": "2024-04-26T18:17:49.6898408-07:00", "StatusType": { "StatusTypeId": "a9f3c48e-e757-45e1-a5c4-3c43b3ab3ca6", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "dafe3eb6-48e9-4212-8942-c9e64963e33e", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "17bb9f6d-787e-4399-8b8d-b3efc863ea45", "CreateDate": "2024-04-26T18:17:49.6898408-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-26T18:17:49.6898408-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "c96b4605-ca33-4b06-ab7a-eefdc07a3107", "CreateDate": "2024-04-26T18:17:49.6898408-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-26T18:17:49.6898408-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "f36a9e86-c669-40e3-97a1-25b5dd01c41e", "CreateDate": "2024-04-26T18:17:49.6898408-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-26T18:17:49.6898408-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-04-26T18:17:49.6898408-07:00", "MeasurementValueNeededDate": "2024-04-26T18:17:49.6898408-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "9622bad1-a8c2-445d-92ef-3611835ea6f6", "CreateDate": "2024-04-26T18:17:49.6898408-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-26T18:17:49.6898408-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2024-04-26T18:17:49.6898408-07:00", "WellPurposeType": { "WellPurposeTypeId": "a18bb8e7-38ee-4c27-aed1-301c15960859", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "8bfa18f4-a538-49d3-b49a-aea628748a66", "CreateDate": "2024-04-26T18:17:49.6898408-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-26T18:17:49.6898408-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "78bfc798-db45-427d-8437-0c59d3f3f943", "CreateDate": "2024-04-26T18:17:49.6898408-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-26T18:17:49.6898408-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": "00b638ca-d66c-4b25-83da-738df9012212", "Asset": { "AssetId": "1f3b9552-f70b-4b9b-ab9d-6bcca2f56d16", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "c7f56cba-c289-4f49-82ab-0875c4797a00", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "1f0ceb03-a326-420b-b013-732a7c0d1113", "CreateDate": "2024-04-26T18:17:49.6898408-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-26T18:17:49.6898408-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "7d5b0089-4918-464b-9b6d-71a9cbb85ace", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-26T18:17:49.6898408-07:00", "MeasurementValueNeededDate": "2024-04-26T18:17:49.6898408-07:00", "SourceSystemId": "sample string 3", "CompanyId": "ea104002-cc1c-4209-b0cc-f320136cb311", "CreateDate": "2024-04-26T18:17:49.6898408-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T18:17:49.6898408-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "1ab7ce2a-1fd9-4524-8432-f89bbf822751", "EffectiveDate": "2024-04-26T18:17:49.6898408-07:00", "StateType": { "StateTypeId": "a670c994-5c77-4375-8c95-aee9e899ae2e", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "c7f56cba-c289-4f49-82ab-0875c4797a00", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "1f0ceb03-a326-420b-b013-732a7c0d1113", "CreateDate": "2024-04-26T18:17:49.6898408-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-26T18:17:49.6898408-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "94730790-c807-4cc2-882d-641165cb31bc", "CreateDate": "2024-04-26T18:17:49.6898408-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T18:17:49.6898408-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "2176db75-9ee8-4ad7-87ce-d3a4758515a0", "CreateDate": "2024-04-26T18:17:49.6898408-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-26T18:17:49.6898408-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "1c062470-51b4-46bd-8f68-025e491f3875", "EffectiveDate": "2024-04-26T18:17:49.6898408-07:00", "StatusType": { "StatusTypeId": "0e0d9189-f064-4421-a17c-affc089b8579", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "c7f56cba-c289-4f49-82ab-0875c4797a00", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "1f0ceb03-a326-420b-b013-732a7c0d1113", "CreateDate": "2024-04-26T18:17:49.6898408-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-26T18:17:49.6898408-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "c9fcedbc-1ab2-489f-884b-a4b42e5ea29b", "CreateDate": "2024-04-26T18:17:49.6898408-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-26T18:17:49.6898408-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "0c1a446c-5350-401c-9a7f-ca53dc51cf5b", "CreateDate": "2024-04-26T18:17:49.6898408-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-26T18:17:49.6898408-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-04-26T18:17:49.6898408-07:00", "MeasurementValueNeededDate": "2024-04-26T18:17:49.6898408-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "628e666b-8487-4feb-ba69-dc67b4c6d49e", "CreateDate": "2024-04-26T18:17:49.6898408-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-26T18:17:49.6898408-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2024-04-26T18:17:49.6898408-07:00", "WellPurposeType": { "WellPurposeTypeId": "efa0a1ea-38e9-45dc-8883-4e93c9fb402f", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "f41552f8-0fd4-4066-bad0-1f8a7e8f658e", "CreateDate": "2024-04-26T18:17:49.6898408-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-26T18:17:49.6898408-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "b545eab9-0cec-46b4-8b07-4defd7ba42cd", "CreateDate": "2024-04-26T18:17:49.6898408-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-26T18:17:49.6898408-07:00", "LastModifiedUser": "sample string 4" }, "Total": 1, "Message": "sample string 1" }