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": "2a7abe47-b0be-48fe-add9-584210e44bb5", "Asset": { "AssetId": "4c7d596a-7581-4a79-acab-329ec3afec36", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "94cd306d-ab8d-441c-b530-5a78c2cfc18f", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "d5c6ab58-8a43-42f9-abe8-00b8ede65932", "CreateDate": "2025-06-02T15:39:39.0092659-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:39:39.0092659-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "187435f9-c656-4a8e-98e4-e76a46946cfb", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-02T15:39:39.0092659-07:00", "MeasurementValueNeededDate": "2025-06-02T15:39:39.0092659-07:00", "SourceSystemId": "sample string 3", "CompanyId": "b590c8f2-72a7-4246-a030-3f224462bf92", "CreateDate": "2025-06-02T15:39:39.0092659-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T15:39:39.0092659-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "e35b6d5d-7a45-4bd4-8fd2-bc8f34912367", "EffectiveDate": "2025-06-02T15:39:39.0092659-07:00", "StateType": { "StateTypeId": "aa121c8a-55cf-4661-941f-b0b3eb7eeeda", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "94cd306d-ab8d-441c-b530-5a78c2cfc18f", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "d5c6ab58-8a43-42f9-abe8-00b8ede65932", "CreateDate": "2025-06-02T15:39:39.0092659-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:39:39.0092659-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "c46b0231-933f-4b9e-8dd0-b9b9cd16e030", "CreateDate": "2025-06-02T15:39:39.0092659-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T15:39:39.0092659-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "070bcb4e-4b3f-49f5-9d7e-f35d5d2d5b8f", "CreateDate": "2025-06-02T15:39:39.0092659-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-02T15:39:39.0092659-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "e611f0e0-46d8-4b09-9be6-8ab835c9f4d2", "EffectiveDate": "2025-06-02T15:39:39.0092659-07:00", "StatusType": { "StatusTypeId": "babe15e8-d940-46b8-85ef-e986c7c577e1", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "94cd306d-ab8d-441c-b530-5a78c2cfc18f", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "d5c6ab58-8a43-42f9-abe8-00b8ede65932", "CreateDate": "2025-06-02T15:39:39.0092659-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:39:39.0092659-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "c8bb9519-0194-482a-aeef-c9a04b7e5d54", "CreateDate": "2025-06-02T15:39:39.0092659-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T15:39:39.0092659-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "83559b63-4d5c-499b-9e85-939896079a2d", "CreateDate": "2025-06-02T15:39:39.0092659-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-02T15:39:39.0092659-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-06-02T15:39:39.0092659-07:00", "MeasurementValueNeededDate": "2025-06-02T15:39:39.0092659-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "f1f4ac3d-9723-4849-b5c7-98585d2cbd64", "CreateDate": "2025-06-02T15:39:39.0092659-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:39:39.0092659-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2025-06-02T15:39:39.0092659-07:00", "WellPurposeType": { "WellPurposeTypeId": "bce5f776-4ab1-4e88-a357-6f4a26bf12ee", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "b2fb6fb1-61e8-4f95-b673-8aa820fcbb72", "CreateDate": "2025-06-02T15:39:39.0092659-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T15:39:39.0092659-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "e753220f-9b35-4aca-86b0-047acd4641fb", "CreateDate": "2025-06-02T15:39:39.0092659-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-02T15:39:39.0092659-07:00", "LastModifiedUser": "sample string 4" }, "Total": 1, "Message": "sample string 1" }