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": "daf249d6-48ba-4fe0-8f0c-3728f871f642",
"Asset": {
"AssetId": "e40d12b1-efde-41a4-9a0e-d9868289489a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "f3a7dbbe-ff1c-4cfb-bf97-d2b1be6f6575",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0bc43b2e-9faf-46f4-9f8b-57e1d5267581",
"CreateDate": "2026-07-15T13:23:10.4593088-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-15T13:23:10.4593088-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "bfe41e97-aa7d-498a-8a02-26aeffd7244d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-15T13:23:10.4593088-07:00",
"MeasurementValueNeededDate": "2026-07-15T13:23:10.4593088-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "0bd4a988-2ac8-44f1-8951-9bd9cef7219a",
"CreateDate": "2026-07-15T13:23:10.4593088-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-15T13:23:10.4593088-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "9aafe053-8d46-453c-9a47-736a2176da8a",
"EffectiveDate": "2026-07-15T13:23:10.4593088-07:00",
"StateType": {
"StateTypeId": "43fe89e2-2eae-4c27-8c7f-ac8c47f61432",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "f3a7dbbe-ff1c-4cfb-bf97-d2b1be6f6575",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0bc43b2e-9faf-46f4-9f8b-57e1d5267581",
"CreateDate": "2026-07-15T13:23:10.4593088-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-15T13:23:10.4593088-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "f8b134c2-9ae3-46dd-bac6-88d96c20eb45",
"CreateDate": "2026-07-15T13:23:10.4593088-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-15T13:23:10.4593088-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "31c33de0-50df-472a-bc7d-a73641c0c68f",
"CreateDate": "2026-07-15T13:23:10.4593088-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-15T13:23:10.4593088-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "8c0f353a-3082-4a11-bc56-bb5cddf0dd11",
"EffectiveDate": "2026-07-15T13:23:10.4593088-07:00",
"StatusType": {
"StatusTypeId": "69e6cd69-b584-46c8-bd99-4325b514f389",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "f3a7dbbe-ff1c-4cfb-bf97-d2b1be6f6575",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0bc43b2e-9faf-46f4-9f8b-57e1d5267581",
"CreateDate": "2026-07-15T13:23:10.4593088-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-15T13:23:10.4593088-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "4b9b7fd9-2578-4d4d-bac5-618f1d8c105c",
"CreateDate": "2026-07-15T13:23:10.4593088-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-15T13:23:10.4593088-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "54e0cb62-4ac4-48d2-819b-dd186fd5bbd7",
"CreateDate": "2026-07-15T13:23:10.4593088-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-15T13:23:10.4593088-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-07-15T13:23:10.4593088-07:00",
"MeasurementValueNeededDate": "2026-07-15T13:23:10.4593088-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "73c238c5-85b4-45a4-92a9-a7390e2533ce",
"CreateDate": "2026-07-15T13:23:10.4593088-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-15T13:23:10.4593088-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2026-07-15T13:23:10.4593088-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "975727a2-7292-4b65-bd05-170214a166c0",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "6b7eedf7-8640-4f23-94ca-c6b57c1d9022",
"CreateDate": "2026-07-15T13:23:10.4593088-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-15T13:23:10.4593088-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "aaafbc65-63e0-4316-b8b5-da73faa50e1e",
"CreateDate": "2026-07-15T13:23:10.4593088-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-15T13:23:10.4593088-07: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"
}