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": "e64fe54c-c266-480e-abe3-dbdfcf4355db",
"Asset": {
"AssetId": "91181080-7fc2-4cc8-9c3c-9a5cb9351076",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "546cde97-a050-4afa-b704-6dda6d031ba9",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "16d75225-b069-4060-8d9e-0b5612447e16",
"CreateDate": "2026-11-21T11:57:15.8593764-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T11:57:15.8593764-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "eb598fbe-14aa-425a-b25e-4137e533e4d4",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-21T11:57:15.8593764-08:00",
"MeasurementValueNeededDate": "2026-11-21T11:57:15.8593764-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b52b649d-d1e8-40e4-9a9e-52d3a382dcd0",
"CreateDate": "2026-11-21T11:57:15.8593764-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T11:57:15.8593764-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "23663310-7099-4d59-8fd2-a9c857cc6f2e",
"EffectiveDate": "2026-11-21T11:57:15.8593764-08:00",
"StateType": {
"StateTypeId": "b4b7a718-5c37-4f90-aeb0-d38f722ffa32",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "546cde97-a050-4afa-b704-6dda6d031ba9",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "16d75225-b069-4060-8d9e-0b5612447e16",
"CreateDate": "2026-11-21T11:57:15.8593764-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T11:57:15.8593764-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "54c1aa9d-376b-4c2e-a5d1-b0dfa88af562",
"CreateDate": "2026-11-21T11:57:15.8593764-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T11:57:15.8593764-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0da4f5a7-1f7a-4b42-9c72-d83d021c5de5",
"CreateDate": "2026-11-21T11:57:15.8593764-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-21T11:57:15.8593764-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "fdda6958-7092-4d9a-95bb-05b221eeb23a",
"EffectiveDate": "2026-11-21T11:57:15.8593764-08:00",
"StatusType": {
"StatusTypeId": "f523b34e-3ab8-4692-bbdf-33fb0598bfe1",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "546cde97-a050-4afa-b704-6dda6d031ba9",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "16d75225-b069-4060-8d9e-0b5612447e16",
"CreateDate": "2026-11-21T11:57:15.8593764-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T11:57:15.8593764-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "fb0ebd49-908e-4900-9892-73906c805bfa",
"CreateDate": "2026-11-21T11:57:15.8593764-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T11:57:15.8593764-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d7450c11-2cfd-4985-94a5-d89baf3af087",
"CreateDate": "2026-11-21T11:57:15.8593764-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-21T11:57:15.8593764-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-21T11:57:15.8593764-08:00",
"MeasurementValueNeededDate": "2026-11-21T11:57:15.8593764-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "ee0b9869-54b4-474a-85c0-c4cc324b5591",
"CreateDate": "2026-11-21T11:57:15.8593764-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T11:57:15.8593764-08:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2026-11-21T11:57:15.8593764-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "c3350319-ef91-4d6f-a5f4-93a9ea8e2315",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "edce6e73-1d52-4383-b3ab-abdafabdb419",
"CreateDate": "2026-11-21T11:57:15.8593764-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T11:57:15.8593764-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "55c28628-e96a-4d6b-8fd3-d90a32680a87",
"CreateDate": "2026-11-21T11:57:15.8593764-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-21T11:57:15.8593764-08:00",
"LastModifiedUser": "sample string 4"
},
"Total": 1,
"Message": "sample string 1"
}