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": "d916cfad-a752-4f92-bab1-9056f604edb7", "Asset": { "AssetId": "c360d192-1313-4187-a5fc-afd974b7a360", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "d42656fb-33fb-4251-8eb8-9fdf77c0cf34", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "808428c7-be98-4414-8ad3-e2fc671829cf", "CreateDate": "2025-07-19T01:26:18.0581403-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T01:26:18.0581403-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "4cf96352-e842-43e0-830a-06cb1b0d20c5", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-19T01:26:18.0581403-07:00", "MeasurementValueNeededDate": "2025-07-19T01:26:18.0581403-07:00", "SourceSystemId": "sample string 3", "CompanyId": "1273426a-b7f2-4af0-9666-0433ccb4764e", "CreateDate": "2025-07-19T01:26:18.0581403-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T01:26:18.0581403-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "d6ad23b7-901f-4e17-928a-5e5a8506d739", "EffectiveDate": "2025-07-19T01:26:18.0581403-07:00", "StateType": { "StateTypeId": "5f01b288-9292-41be-bf14-4d4c4885cbac", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "d42656fb-33fb-4251-8eb8-9fdf77c0cf34", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "808428c7-be98-4414-8ad3-e2fc671829cf", "CreateDate": "2025-07-19T01:26:18.0581403-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T01:26:18.0581403-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "75e0ae00-d11b-45c0-9df1-616a8b885614", "CreateDate": "2025-07-19T01:26:18.0581403-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T01:26:18.0581403-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "e61aeb4f-de62-44ff-a54c-57bf356d6851", "CreateDate": "2025-07-19T01:26:18.0581403-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-19T01:26:18.0581403-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "7df899cb-d844-4819-ae1d-326aef513662", "EffectiveDate": "2025-07-19T01:26:18.0581403-07:00", "StatusType": { "StatusTypeId": "8ea39a19-f66a-47c6-8c64-265013d41c43", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "d42656fb-33fb-4251-8eb8-9fdf77c0cf34", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "808428c7-be98-4414-8ad3-e2fc671829cf", "CreateDate": "2025-07-19T01:26:18.0581403-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T01:26:18.0581403-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "caf1c63c-ac2e-4c59-9d7f-904dec0e0829", "CreateDate": "2025-07-19T01:26:18.0581403-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-19T01:26:18.0581403-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "c51c94a2-22fb-40fb-bedc-87de686559cd", "CreateDate": "2025-07-19T01:26:18.0581403-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-19T01:26:18.0581403-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-07-19T01:26:18.0581403-07:00", "MeasurementValueNeededDate": "2025-07-19T01:26:18.0581403-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "d51aa2e1-1d55-4881-839e-f6b2e5a6764a", "CreateDate": "2025-07-19T01:26:18.0581403-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T01:26:18.0581403-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2025-07-19T01:26:18.0581403-07:00", "WellPurposeType": { "WellPurposeTypeId": "9234a11d-e9d6-416f-af6f-03a85b8f5d77", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "e82e3329-c888-4eb9-89e9-d82db4af856c", "CreateDate": "2025-07-19T01:26:18.0581403-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-19T01:26:18.0581403-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "7a11721b-c33d-432f-a8b5-640877f011c6", "CreateDate": "2025-07-19T01:26:18.0581403-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-19T01:26:18.0581403-07:00", "LastModifiedUser": "sample string 4" }, "Total": 1, "Message": "sample string 1" }