PUT WellPurposes
Updates the given well purpose.
Request Information
URI Parameters
None.
Body Parameters
Well purpose to be updated
WellPurpose| Name | 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": "b028922a-5714-46a6-8467-87ee58cccf99",
"Asset": {
"AssetId": "45725afe-d500-4b13-a20a-78c1e1beb8b8",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "bb88c53c-262b-4ee6-8536-7f648f26f269",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "3e9ec201-9755-4e4d-aeab-d67e1d44cf88",
"CreateDate": "2026-11-21T11:57:13.8437566-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T11:57:13.8437566-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "c75742e8-0429-4951-beb9-3fad64d4f2e3",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-21T11:57:13.8437566-08:00",
"MeasurementValueNeededDate": "2026-11-21T11:57:13.8437566-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "0658c781-11cb-4959-91b3-963af45b98ec",
"CreateDate": "2026-11-21T11:57:13.8437566-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T11:57:13.8437566-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "caa85778-55e3-4058-9592-82c9f6c0e506",
"EffectiveDate": "2026-11-21T11:57:13.8437566-08:00",
"StateType": {
"StateTypeId": "b1e47e2d-1063-41af-8c78-8a7d7e6a9528",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "bb88c53c-262b-4ee6-8536-7f648f26f269",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "3e9ec201-9755-4e4d-aeab-d67e1d44cf88",
"CreateDate": "2026-11-21T11:57:13.8437566-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T11:57:13.8437566-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "d3106f0f-fd58-4aed-be05-e12b860ad71e",
"CreateDate": "2026-11-21T11:57:13.8437566-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T11:57:13.8437566-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "bccea8a4-cfb9-4990-8ddf-4af52b7b665c",
"CreateDate": "2026-11-21T11:57:13.8437566-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-21T11:57:13.8437566-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "5f520cb7-8493-4cfe-8c6b-94b92beab5dd",
"EffectiveDate": "2026-11-21T11:57:13.8437566-08:00",
"StatusType": {
"StatusTypeId": "ae8f051f-29f9-4d87-8a64-b2e55cd43803",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "bb88c53c-262b-4ee6-8536-7f648f26f269",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "3e9ec201-9755-4e4d-aeab-d67e1d44cf88",
"CreateDate": "2026-11-21T11:57:13.8437566-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T11:57:13.8437566-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "665e808d-ea9b-4cdb-a1fd-576c9bb3d924",
"CreateDate": "2026-11-21T11:57:13.8437566-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T11:57:13.8437566-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b4106efd-e1d1-4bd0-9e22-3e59ddeba4b1",
"CreateDate": "2026-11-21T11:57:13.8437566-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-21T11:57:13.8437566-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-21T11:57:13.8437566-08:00",
"MeasurementValueNeededDate": "2026-11-21T11:57:13.8437566-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "f2790a1d-0753-469c-8e84-f7806bb6a586",
"CreateDate": "2026-11-21T11:57:13.8437566-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T11:57:13.8437566-08:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2026-11-21T11:57:13.8437566-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "295b225a-5e7e-4d07-bca5-7be9f0b79e9f",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f5df40a4-9200-443d-a6f7-831414f002a5",
"CreateDate": "2026-11-21T11:57:13.8437566-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T11:57:13.8437566-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "08c78b29-c6a9-41c7-8f61-ff68252a795b",
"CreateDate": "2026-11-21T11:57:13.8437566-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-21T11:57:13.8437566-08: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": "e1ab00b2-512c-4169-85ca-0a8e80dc6823",
"Asset": {
"AssetId": "46e79ed4-cd31-4ffe-ac60-67e40356a49c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "447a3f15-9d44-457d-b68c-07401bb40cd2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b75cb7e9-29b7-40a7-b5cc-afa10b45574a",
"CreateDate": "2026-11-21T11:57:13.859421-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T11:57:13.859421-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "061d402a-8c60-4d37-a331-26d3a9dcd1ff",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-21T11:57:13.859421-08:00",
"MeasurementValueNeededDate": "2026-11-21T11:57:13.859421-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "0dbb91c9-e526-4479-a6f5-c82fad58ea63",
"CreateDate": "2026-11-21T11:57:13.859421-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T11:57:13.859421-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "fd00f612-a1d9-4214-9909-fa0c34b95191",
"EffectiveDate": "2026-11-21T11:57:13.859421-08:00",
"StateType": {
"StateTypeId": "b9d6d5ae-ca48-45e9-970d-3afbfe5705a3",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "447a3f15-9d44-457d-b68c-07401bb40cd2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b75cb7e9-29b7-40a7-b5cc-afa10b45574a",
"CreateDate": "2026-11-21T11:57:13.859421-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T11:57:13.859421-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "468f53d9-9dcc-4388-bac8-7fc038b6dddb",
"CreateDate": "2026-11-21T11:57:13.859421-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T11:57:13.859421-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0dd0d68e-2ee7-4f03-9857-c3c583e37f67",
"CreateDate": "2026-11-21T11:57:13.859421-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-21T11:57:13.859421-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "e1e25562-f82d-4008-a56f-4adb11be3073",
"EffectiveDate": "2026-11-21T11:57:13.859421-08:00",
"StatusType": {
"StatusTypeId": "4ff90071-f79d-4a9d-90ad-b9a2018db502",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "447a3f15-9d44-457d-b68c-07401bb40cd2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b75cb7e9-29b7-40a7-b5cc-afa10b45574a",
"CreateDate": "2026-11-21T11:57:13.859421-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T11:57:13.859421-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "af9e454c-d5e8-4747-8737-8e5dfd915484",
"CreateDate": "2026-11-21T11:57:13.859421-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T11:57:13.859421-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a348a401-656e-48d6-96cc-894df59cfdf2",
"CreateDate": "2026-11-21T11:57:13.859421-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-21T11:57:13.859421-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-21T11:57:13.859421-08:00",
"MeasurementValueNeededDate": "2026-11-21T11:57:13.859421-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "21deb68c-0319-4e0e-be51-a58899e03893",
"CreateDate": "2026-11-21T11:57:13.859421-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T11:57:13.859421-08:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2026-11-21T11:57:13.859421-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "db6d6372-473f-424c-8b8b-6c6e757c0775",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "94a835f4-beac-4be4-98a3-3a61ec9fd1d4",
"CreateDate": "2026-11-21T11:57:13.859421-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T11:57:13.859421-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a3f7294d-dcf9-4236-ac66-cfdd543bd5b0",
"CreateDate": "2026-11-21T11:57:13.859421-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-21T11:57:13.859421-08:00",
"LastModifiedUser": "sample string 4"
},
"Total": 1,
"Message": "sample string 1"
}