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": "248a0ef8-4f98-4d45-91f4-1e72c2b7a905", "Asset": { "AssetId": "38950fbc-9cb1-449d-9f69-087cea8e7ac9", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "84f9705d-3d0e-4740-8692-d3685f76e720", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "9203dee0-2a9c-4a8a-891e-068c4cb7dd84", "CreateDate": "2024-03-29T07:50:50.1643054-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-03-29T07:50:50.1643054-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "022b6520-cd7e-4bdc-a186-b8f88d40435e", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-03-29T07:50:50.1643054-07:00", "MeasurementValueNeededDate": "2024-03-29T07:50:50.1643054-07:00", "SourceSystemId": "sample string 3", "CompanyId": "e1c78ee4-649f-485f-9804-b3c68dd9eea3", "CreateDate": "2024-03-29T07:50:50.1643054-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-29T07:50:50.1643054-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "f67764c7-85fd-489d-bd64-2a94d780abce", "EffectiveDate": "2024-03-29T07:50:50.1643054-07:00", "StateType": { "StateTypeId": "01555151-742d-4a4d-92fb-3df436cdcb57", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "84f9705d-3d0e-4740-8692-d3685f76e720", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "9203dee0-2a9c-4a8a-891e-068c4cb7dd84", "CreateDate": "2024-03-29T07:50:50.1643054-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-03-29T07:50:50.1643054-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "d1940710-1668-42e7-89f3-2225b64eefd9", "CreateDate": "2024-03-29T07:50:50.1643054-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-29T07:50:50.1643054-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "3b6e71fe-caca-4c69-be4a-699df5000f8b", "CreateDate": "2024-03-29T07:50:50.1643054-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-03-29T07:50:50.1643054-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "a8728ecb-160b-45c3-a95c-95e57eac499d", "EffectiveDate": "2024-03-29T07:50:50.1643054-07:00", "StatusType": { "StatusTypeId": "f565c22e-507c-45a7-a157-188a8f71761d", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "84f9705d-3d0e-4740-8692-d3685f76e720", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "9203dee0-2a9c-4a8a-891e-068c4cb7dd84", "CreateDate": "2024-03-29T07:50:50.1643054-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-03-29T07:50:50.1643054-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "34dd4fd6-7bd2-498d-af15-2e47177e4160", "CreateDate": "2024-03-29T07:50:50.1643054-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-03-29T07:50:50.1643054-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "04feca25-27ae-4cc2-8130-0e46cc7d829d", "CreateDate": "2024-03-29T07:50:50.1643054-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-03-29T07:50:50.1643054-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-03-29T07:50:50.1643054-07:00", "MeasurementValueNeededDate": "2024-03-29T07:50:50.1643054-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "b675588d-923f-47a3-995e-fb3e9955df1d", "CreateDate": "2024-03-29T07:50:50.1643054-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-03-29T07:50:50.1643054-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2024-03-29T07:50:50.1643054-07:00", "WellPurposeType": { "WellPurposeTypeId": "7faa5fd7-25ee-45dc-a61b-f6ae6f334ae3", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "7c80ef7b-ffa9-4a99-b0e5-be85aaf704dc", "CreateDate": "2024-03-29T07:50:50.1643054-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-03-29T07:50:50.1643054-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "99648205-4683-419e-a8d2-ba0a12391c68", "CreateDate": "2024-03-29T07:50:50.1643054-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-03-29T07:50:50.1643054-07:00", "LastModifiedUser": "sample string 4" }, "Total": 1, "Message": "sample string 1" }