DELETE WellPurposes
Deletes the given well purpose.
Request Information
URI Parameters
None.
Body Parameters
Well purpose to delete
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": "3c66f344-03cb-42bc-b5d9-bf63e28f19fe",
"Asset": {
"AssetId": "ec60e3a4-e755-4233-a91a-45b589ff2113",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "348949d2-de00-4b02-975e-4d16c04b4845",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6be058b8-6628-4188-bf83-376b6c7db774",
"CreateDate": "2025-12-17T04:32:42.9217546-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-17T04:32:42.9217546-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "7e92afc8-9592-4c01-8905-2c7eb1bc47c8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-17T04:32:42.9217546-08:00",
"MeasurementValueNeededDate": "2025-12-17T04:32:42.9217546-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "6cb6e017-8d4e-446c-96ab-65883f0403e0",
"CreateDate": "2025-12-17T04:32:42.9217546-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-17T04:32:42.9217546-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "1675006b-012a-4356-a3b1-39fa8d2c9425",
"EffectiveDate": "2025-12-17T04:32:42.9217546-08:00",
"StateType": {
"StateTypeId": "67c2f93a-f506-4335-9380-bcc730351183",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "348949d2-de00-4b02-975e-4d16c04b4845",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6be058b8-6628-4188-bf83-376b6c7db774",
"CreateDate": "2025-12-17T04:32:42.9217546-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-17T04:32:42.9217546-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "44e00c52-ab95-471c-b93c-3bc613087f13",
"CreateDate": "2025-12-17T04:32:42.9217546-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-17T04:32:42.9217546-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b3245a76-9681-41bd-aaa1-759b4845e44b",
"CreateDate": "2025-12-17T04:32:42.9217546-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-17T04:32:42.9217546-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "64dff1b7-ecdd-4ab2-bce4-aeec1ac5bc8f",
"EffectiveDate": "2025-12-17T04:32:42.9217546-08:00",
"StatusType": {
"StatusTypeId": "051fbf8f-9edd-4ab2-a02a-d658508d5080",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "348949d2-de00-4b02-975e-4d16c04b4845",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6be058b8-6628-4188-bf83-376b6c7db774",
"CreateDate": "2025-12-17T04:32:42.9217546-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-17T04:32:42.9217546-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "ada38737-8257-425f-88c8-e400b0d31c9b",
"CreateDate": "2025-12-17T04:32:42.9217546-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-17T04:32:42.9217546-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "22e402e0-7c06-45d4-a37b-a5a25b400506",
"CreateDate": "2025-12-17T04:32:42.9217546-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-17T04:32:42.9217546-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-12-17T04:32:42.9217546-08:00",
"MeasurementValueNeededDate": "2025-12-17T04:32:42.9217546-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "7a743e30-32bf-4512-80c7-f8672a20b733",
"CreateDate": "2025-12-17T04:32:42.9217546-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-17T04:32:42.9217546-08:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2025-12-17T04:32:42.9217546-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "b043cf16-1080-4ae3-a3ca-92facf48619f",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c848c626-6c13-4a15-8fcf-18a57fa37a47",
"CreateDate": "2025-12-17T04:32:42.9217546-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-17T04:32:42.9217546-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5affd6be-62be-48b7-a958-8e17affd242c",
"CreateDate": "2025-12-17T04:32:42.9217546-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-17T04:32:42.9217546-08:00",
"LastModifiedUser": "sample string 4"
}
Response Information
Resource Description
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Object |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": {},
"Total": 1,
"Message": "sample string 2"
}