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": "cf6f5b06-d162-4470-9ff1-39c3aeb48bde", "Asset": { "AssetId": "1654aba8-e120-4d91-8a07-02692db57f10", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "616cc2f1-f235-495e-872c-9f8587979a0b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "07d19f3a-36bb-49b1-935c-d8571cc444d3", "CreateDate": "2024-04-28T13:46:55.6871952-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T13:46:55.6871952-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "ba1e7c00-5289-4b3a-a87b-e16e074f1f07", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-28T13:46:55.6871952-07:00", "MeasurementValueNeededDate": "2024-04-28T13:46:55.6871952-07:00", "SourceSystemId": "sample string 3", "CompanyId": "8a3cddd8-b25e-4713-a5d8-d055561eed43", "CreateDate": "2024-04-28T13:46:55.6871952-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T13:46:55.6871952-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "fa93f4be-bcd1-4bc8-859f-eadcee0f220a", "EffectiveDate": "2024-04-28T13:46:55.6871952-07:00", "StateType": { "StateTypeId": "a0f23b0d-5293-4f29-a3cc-9cbf840ca3bd", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "616cc2f1-f235-495e-872c-9f8587979a0b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "07d19f3a-36bb-49b1-935c-d8571cc444d3", "CreateDate": "2024-04-28T13:46:55.6871952-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T13:46:55.6871952-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "586d7048-e2ab-45ce-a4bd-e186afa82fdf", "CreateDate": "2024-04-28T13:46:55.6871952-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T13:46:55.6871952-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "ea91b754-1bd7-444b-8dec-97cab47998c6", "CreateDate": "2024-04-28T13:46:55.6871952-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T13:46:55.6871952-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "41c34cd0-716e-423a-86b7-7f75af8eddef", "EffectiveDate": "2024-04-28T13:46:55.6871952-07:00", "StatusType": { "StatusTypeId": "a9f960c8-07c0-4a32-b81d-a14cea7285a0", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "616cc2f1-f235-495e-872c-9f8587979a0b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "07d19f3a-36bb-49b1-935c-d8571cc444d3", "CreateDate": "2024-04-28T13:46:55.6871952-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T13:46:55.6871952-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "37266fd8-f763-48e7-b2bb-90f05bd4d594", "CreateDate": "2024-04-28T13:46:55.6871952-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T13:46:55.6871952-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "b3009954-716c-4dfe-82db-aa5ec6f7ff33", "CreateDate": "2024-04-28T13:46:55.6871952-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T13:46:55.6871952-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-04-28T13:46:55.6871952-07:00", "MeasurementValueNeededDate": "2024-04-28T13:46:55.6871952-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "b9aac615-e651-42c7-b591-ffe67388e624", "CreateDate": "2024-04-28T13:46:55.6871952-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T13:46:55.6871952-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2024-04-28T13:46:55.6871952-07:00", "WellPurposeType": { "WellPurposeTypeId": "140e01f8-adad-41e3-b490-250bf966023f", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "08ede7e0-59c8-43fe-9b11-f6141a8a7c4a", "CreateDate": "2024-04-28T13:46:55.6871952-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T13:46:55.6871952-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "f3a742c5-d121-4a39-85e8-9f67d9c2e76b", "CreateDate": "2024-04-28T13:46:55.6871952-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T13:46:55.6871952-07:00", "LastModifiedUser": "sample string 4" }, "Total": 1, "Message": "sample string 1" }