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": "f0e570f2-4c3c-4fcc-8401-9c7152c06806",
"Asset": {
"AssetId": "2d88cbfd-d61f-4063-98dd-b3ee92924993",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "c949e8f1-0bb2-48ec-abc8-7a8c6433f774",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "49603190-18dc-419e-a019-7f820b45cf4d",
"CreateDate": "2026-03-15T18:03:38.5606505-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-15T18:03:38.5606505-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "0f3e3caf-9e27-4060-8c31-b4d6d9f6f0e1",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-15T18:03:38.5606505-07:00",
"MeasurementValueNeededDate": "2026-03-15T18:03:38.5606505-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f09df0cf-d4f6-4163-8ea9-37c5a7a87fc9",
"CreateDate": "2026-03-15T18:03:38.5606505-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T18:03:38.5606505-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "378b04c3-ab05-418e-93dc-c9693dba39ad",
"EffectiveDate": "2026-03-15T18:03:38.5606505-07:00",
"StateType": {
"StateTypeId": "b9ce5097-903c-48ca-b104-9cb8f67f0184",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "c949e8f1-0bb2-48ec-abc8-7a8c6433f774",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "49603190-18dc-419e-a019-7f820b45cf4d",
"CreateDate": "2026-03-15T18:03:38.5606505-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-15T18:03:38.5606505-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "12169b7c-8176-4256-b241-d13c9b153348",
"CreateDate": "2026-03-15T18:03:38.5606505-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T18:03:38.5606505-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "db57db94-dfe0-488f-b181-95294bd9b309",
"CreateDate": "2026-03-15T18:03:38.5606505-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-15T18:03:38.5606505-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "faf5a6bf-c485-49ad-b438-e91c86317bd5",
"EffectiveDate": "2026-03-15T18:03:38.5606505-07:00",
"StatusType": {
"StatusTypeId": "3e50eacb-99fd-4937-b766-f56d802faf8c",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "c949e8f1-0bb2-48ec-abc8-7a8c6433f774",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "49603190-18dc-419e-a019-7f820b45cf4d",
"CreateDate": "2026-03-15T18:03:38.5606505-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-15T18:03:38.5606505-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "22e6d86b-3203-45d8-8451-f6980193389c",
"CreateDate": "2026-03-15T18:03:38.5606505-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-15T18:03:38.5606505-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "66bf11e0-94e5-41d7-8652-5384611c7dbd",
"CreateDate": "2026-03-15T18:03:38.5606505-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-15T18:03:38.5606505-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-15T18:03:38.5606505-07:00",
"MeasurementValueNeededDate": "2026-03-15T18:03:38.5606505-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "ea85f1c5-6fee-44e7-bcf5-cc4c8c38770d",
"CreateDate": "2026-03-15T18:03:38.5606505-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-15T18:03:38.5606505-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2026-03-15T18:03:38.5606505-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "67bd4303-6c18-48d2-a7bb-2b3a95fe8feb",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c3ef8038-671c-47f0-bdc3-1a17ad566f4f",
"CreateDate": "2026-03-15T18:03:38.5606505-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-15T18:03:38.5606505-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2d78b14c-2c3a-4bac-98ee-429b0fc58230",
"CreateDate": "2026-03-15T18:03:38.5606505-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-15T18:03:38.5606505-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"
}