GET WellPurposes?wellPurposeId={wellPurposeId}
Retrieves a well purpose by its Id.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| wellPurposeId |
Id of the well purpose |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
On success, the 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": "589001e3-d81f-4ae9-b78f-ea13fbef16dc",
"Asset": {
"AssetId": "ef756c0c-3e0e-4d99-8493-bc2773952a05",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "35ee324f-ad20-461d-ae1a-ae40afa3d85d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8e7ae05e-42f7-4bf5-b129-9638d82a5bf2",
"CreateDate": "2026-11-22T14:13:01.9726444-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:13:01.9726444-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "9737aabd-d245-43fd-a566-1c065ec3c465",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-22T14:13:01.9726444-08:00",
"MeasurementValueNeededDate": "2026-11-22T14:13:01.9726444-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "0b5b3edd-4aef-4cc6-829c-f614819aa253",
"CreateDate": "2026-11-22T14:13:01.9726444-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:13:01.9726444-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "8c3ec4e2-e12c-4501-bb21-d6b3a68ca439",
"EffectiveDate": "2026-11-22T14:13:01.9726444-08:00",
"StateType": {
"StateTypeId": "d647a8cb-a244-46b9-b770-49be4ef9d52a",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "35ee324f-ad20-461d-ae1a-ae40afa3d85d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8e7ae05e-42f7-4bf5-b129-9638d82a5bf2",
"CreateDate": "2026-11-22T14:13:01.9726444-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:13:01.9726444-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "ed7676f7-9c4e-4533-9de9-962c45e9eff8",
"CreateDate": "2026-11-22T14:13:01.9726444-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:13:01.9726444-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a3eaf0cc-410a-4867-b6e8-b66d1a16ee98",
"CreateDate": "2026-11-22T14:13:01.9726444-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T14:13:01.9726444-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "9e2239d0-c0a0-43ac-a37d-f6851f5a7909",
"EffectiveDate": "2026-11-22T14:13:01.9726444-08:00",
"StatusType": {
"StatusTypeId": "b4dbac5b-9bd8-43d0-93d4-593697213fe8",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "35ee324f-ad20-461d-ae1a-ae40afa3d85d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8e7ae05e-42f7-4bf5-b129-9638d82a5bf2",
"CreateDate": "2026-11-22T14:13:01.9726444-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:13:01.9726444-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "c6c71118-f83f-40f5-846b-dac4ea71723b",
"CreateDate": "2026-11-22T14:13:01.9726444-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-22T14:13:01.9726444-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "fd21125e-3fdb-4537-9c9d-353e86290cc0",
"CreateDate": "2026-11-22T14:13:01.9726444-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T14:13:01.9726444-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-22T14:13:01.9726444-08:00",
"MeasurementValueNeededDate": "2026-11-22T14:13:01.9726444-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "8bd25b36-bced-4a64-89e0-3b2186512586",
"CreateDate": "2026-11-22T14:13:01.9726444-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:13:01.9726444-08:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2026-11-22T14:13:01.9726444-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "6e5f3717-b0f8-4d64-b263-bc7e112dc29d",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2e1fd3f2-6fc5-4848-acdc-f8024e22e595",
"CreateDate": "2026-11-22T14:13:01.9726444-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-22T14:13:01.9726444-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4938adc6-da5a-4079-80df-2619bbf54ff8",
"CreateDate": "2026-11-22T14:13:01.9726444-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T14:13:01.9726444-08:00",
"LastModifiedUser": "sample string 4"
},
"Total": 1,
"Message": "sample string 1"
}