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": "e23b8fcf-9aeb-41e5-921f-c2465d5164c2", "Asset": { "AssetId": "6a810121-82be-4976-aeba-41ba119d8c07", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "a0b1ea55-ba07-4d5f-b98a-2631adc6e885", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "38fc061c-fc97-4a06-bdc6-f8a2526fe29e", "CreateDate": "2025-07-30T23:27:28.6659511-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:27:28.6659511-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "bd44e40d-287a-40f6-aa98-e2e24d35ea05", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-30T23:27:28.6659511-07:00", "MeasurementValueNeededDate": "2025-07-30T23:27:28.6659511-07:00", "SourceSystemId": "sample string 3", "CompanyId": "7f259ccf-833a-43df-b4d2-bc07c8f704b7", "CreateDate": "2025-07-30T23:27:28.6659511-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T23:27:28.6659511-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "644ec6ac-bd5c-44a1-84a6-fb0a5628c24b", "EffectiveDate": "2025-07-30T23:27:28.6659511-07:00", "StateType": { "StateTypeId": "631a1024-8a5c-4363-95a2-09108e7ea577", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "a0b1ea55-ba07-4d5f-b98a-2631adc6e885", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "38fc061c-fc97-4a06-bdc6-f8a2526fe29e", "CreateDate": "2025-07-30T23:27:28.6659511-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:27:28.6659511-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "0f7154b9-ee32-4e1e-b061-80c050d2e0ee", "CreateDate": "2025-07-30T23:27:28.6659511-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T23:27:28.6659511-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "44f80e70-aa0c-4f28-a561-9402e23498ba", "CreateDate": "2025-07-30T23:27:28.6659511-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-30T23:27:28.6659511-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "0b8cd5b3-1970-4029-a4d4-9faf0f727298", "EffectiveDate": "2025-07-30T23:27:28.6659511-07:00", "StatusType": { "StatusTypeId": "bd16944c-129a-4421-9876-0d0c98d5e404", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "a0b1ea55-ba07-4d5f-b98a-2631adc6e885", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "38fc061c-fc97-4a06-bdc6-f8a2526fe29e", "CreateDate": "2025-07-30T23:27:28.6659511-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:27:28.6659511-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "11eca8b5-7202-4418-a59b-ea68de70eca6", "CreateDate": "2025-07-30T23:27:28.6659511-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-30T23:27:28.6659511-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "30c8c297-6670-489b-b97c-275596e4990a", "CreateDate": "2025-07-30T23:27:28.6659511-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-30T23:27:28.6659511-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-07-30T23:27:28.6659511-07:00", "MeasurementValueNeededDate": "2025-07-30T23:27:28.6659511-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "407097a6-1962-4582-9912-ef0285c2f6f1", "CreateDate": "2025-07-30T23:27:28.6659511-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:27:28.6659511-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2025-07-30T23:27:28.6659511-07:00", "WellPurposeType": { "WellPurposeTypeId": "44487c92-8f90-45af-8589-bb61e20e5214", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "7bdd9068-0cc9-44ae-ad2f-b0d747fdd237", "CreateDate": "2025-07-30T23:27:28.6659511-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-30T23:27:28.6659511-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "5452d881-7d50-49de-9f83-3c9b44b0ccbc", "CreateDate": "2025-07-30T23:27:28.6659511-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-30T23:27:28.6659511-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": "6530a2f6-fe77-4128-a59e-1d8a7bac3c7e", "Asset": { "AssetId": "4e2c5d72-a8d7-4339-8373-70dfbb6bd265", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "f718eddc-4f69-4be2-a7b7-f853254dd493", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "d20614af-3cac-463d-a778-10345e142ac2", "CreateDate": "2025-07-30T23:27:28.6659511-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:27:28.6659511-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "86bd5b40-06c6-40a7-a4a1-54ccef7dc98d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-30T23:27:28.6659511-07:00", "MeasurementValueNeededDate": "2025-07-30T23:27:28.6659511-07:00", "SourceSystemId": "sample string 3", "CompanyId": "8bd3ce31-b5a3-4364-9e3f-7a1b28982933", "CreateDate": "2025-07-30T23:27:28.6659511-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T23:27:28.6659511-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "54b00634-3ac2-430a-b27e-2df82f1147ba", "EffectiveDate": "2025-07-30T23:27:28.6659511-07:00", "StateType": { "StateTypeId": "8ae73de2-e349-4dda-8e75-f3a0d17c80a1", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "f718eddc-4f69-4be2-a7b7-f853254dd493", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "d20614af-3cac-463d-a778-10345e142ac2", "CreateDate": "2025-07-30T23:27:28.6659511-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:27:28.6659511-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "84c48718-e412-40ae-9d42-f6b2175978fa", "CreateDate": "2025-07-30T23:27:28.6659511-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T23:27:28.6659511-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "d4bb06dc-3313-43e7-af47-27c2e205ab46", "CreateDate": "2025-07-30T23:27:28.6659511-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-30T23:27:28.6659511-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "c8e55b6d-5645-4c63-b191-6d36eca27f74", "EffectiveDate": "2025-07-30T23:27:28.6659511-07:00", "StatusType": { "StatusTypeId": "4463a3c8-fdd1-42d4-83e0-3779ff1cfcd6", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "f718eddc-4f69-4be2-a7b7-f853254dd493", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "d20614af-3cac-463d-a778-10345e142ac2", "CreateDate": "2025-07-30T23:27:28.6659511-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:27:28.6659511-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "bd7490ec-5727-4e5a-8a8b-1521722b8cd3", "CreateDate": "2025-07-30T23:27:28.6659511-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-30T23:27:28.6659511-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "564521c0-18bd-4b01-848e-3b6cc91f8650", "CreateDate": "2025-07-30T23:27:28.6659511-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-30T23:27:28.6659511-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-07-30T23:27:28.6659511-07:00", "MeasurementValueNeededDate": "2025-07-30T23:27:28.6659511-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "41816672-b7c8-401e-a661-3a8ecb2830b9", "CreateDate": "2025-07-30T23:27:28.6659511-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:27:28.6659511-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2025-07-30T23:27:28.6659511-07:00", "WellPurposeType": { "WellPurposeTypeId": "d35de8f5-59de-470a-a65f-fde926b7a105", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "d3bdb355-4edb-46b6-998d-a57c98cb9e4e", "CreateDate": "2025-07-30T23:27:28.6659511-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-30T23:27:28.6659511-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "7302a518-dcb1-4659-ad1d-c048544c01c6", "CreateDate": "2025-07-30T23:27:28.6659511-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-30T23:27:28.6659511-07:00", "LastModifiedUser": "sample string 4" }, "Total": 1, "Message": "sample string 1" }