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": "0ff25999-9e36-4e0d-b4f7-ba4ad5f6bedb", "Asset": { "AssetId": "ffde5dcf-8d70-4103-af1b-6eaea2c19cd7", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "80225d0b-6508-4c9b-bead-aaa5deb3db52", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "f3d56160-9bad-4da5-b2f1-b8a6ce5f966e", "CreateDate": "2025-06-27T04:44:43.0299866-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T04:44:43.0299866-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "3f829a45-05c3-42f6-8750-d751316449c7", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-27T04:44:43.0299866-07:00", "MeasurementValueNeededDate": "2025-06-27T04:44:43.0299866-07:00", "SourceSystemId": "sample string 3", "CompanyId": "f026e151-96bf-49c5-a314-276bba56b295", "CreateDate": "2025-06-27T04:44:43.0299866-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T04:44:43.0299866-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "4f4f2458-f212-43c9-aeed-64693e900da0", "EffectiveDate": "2025-06-27T04:44:43.0299866-07:00", "StateType": { "StateTypeId": "b7acd769-a1fd-4641-bd38-dae9221eb9b0", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "80225d0b-6508-4c9b-bead-aaa5deb3db52", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "f3d56160-9bad-4da5-b2f1-b8a6ce5f966e", "CreateDate": "2025-06-27T04:44:43.0299866-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T04:44:43.0299866-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "ab99f24e-f2dd-449a-bcab-5e1ba6d8cebf", "CreateDate": "2025-06-27T04:44:43.0299866-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T04:44:43.0299866-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "c08cb08e-098f-4838-98e5-17e7471ff491", "CreateDate": "2025-06-27T04:44:43.0299866-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-27T04:44:43.0299866-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "a89b5172-b3e1-456c-a5e8-a4372afa698e", "EffectiveDate": "2025-06-27T04:44:43.0299866-07:00", "StatusType": { "StatusTypeId": "cd217612-8c46-4952-9ff1-0f982a15f217", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "80225d0b-6508-4c9b-bead-aaa5deb3db52", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "f3d56160-9bad-4da5-b2f1-b8a6ce5f966e", "CreateDate": "2025-06-27T04:44:43.0299866-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T04:44:43.0299866-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "962c4bea-2aa8-4543-b03d-32ea144bb300", "CreateDate": "2025-06-27T04:44:43.0299866-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-27T04:44:43.0299866-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "54b42b9d-c5c9-4479-85e1-12a07366212b", "CreateDate": "2025-06-27T04:44:43.0299866-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-27T04:44:43.0299866-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-06-27T04:44:43.0299866-07:00", "MeasurementValueNeededDate": "2025-06-27T04:44:43.0299866-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "526d06e2-cd33-4819-be73-38b019d2e184", "CreateDate": "2025-06-27T04:44:43.0299866-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T04:44:43.0299866-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2025-06-27T04:44:43.0299866-07:00", "WellPurposeType": { "WellPurposeTypeId": "f7d545a8-0d3f-4213-88a8-af2d57475f2b", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "4b4837d4-7c19-431d-944c-338784a93a0d", "CreateDate": "2025-06-27T04:44:43.0299866-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-27T04:44:43.0299866-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "1f30510d-8598-4fc4-a966-bc1db79e58af", "CreateDate": "2025-06-27T04:44:43.0299866-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-27T04:44:43.0299866-07:00", "LastModifiedUser": "sample string 4" }, "Total": 1, "Message": "sample string 1" }