GET WellPurposes?assetId={assetId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves well purposes for the given parameters. This will only retrieve well purposes that have a value. All parameters are optional.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
assetId |
Id of the asset |
globally unique identifier |
None. |
take |
Number of well purposes to retrieve. Default is all well purposes |
integer |
None. |
skip |
Number of well purposes to skip before retrieval |
integer |
Default value is 0 |
sort |
List of sorting rules to describe how to sort the well purposes before retrieval |
Collection of Sort |
None. |
Operator | string |
None. |
|
Field | string |
None. |
|
Value | string |
None. |
|
Logic | string |
None. |
|
Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of well purposes.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Collection of WellPurpose |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "WellPurposeId": "02c85f24-6414-4e52-8a12-b370623071ee", "Asset": { "AssetId": "a9cc47f7-a574-45c5-b614-8487e32edbae", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "b96f4872-640b-441a-b1a6-e43a838a6069", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "f51c8437-8c8d-45a5-9d3b-0a8a11703882", "CreateDate": "2023-06-04T03:06:21.6536771-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2023-06-04T03:06:21.6536771-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "738269d3-20a0-4167-964d-e8f71845c4e4", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2023-06-04T03:06:21.6536771-07:00", "MeasurementValueNeededDate": "2023-06-04T03:06:21.6536771-07:00", "SourceSystemId": "sample string 3", "CompanyId": "f69887e6-d4e1-4176-bad9-b7e89ccc6054", "CreateDate": "2023-06-04T03:06:21.6536771-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-06-04T03:06:21.6536771-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "00a55533-e15c-4b32-8829-3858c5ad9a63", "EffectiveDate": "2023-06-04T03:06:21.6536771-07:00", "StateType": { "StateTypeId": "1339c56c-513b-48b8-ab23-06f648279fb7", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "b96f4872-640b-441a-b1a6-e43a838a6069", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "f51c8437-8c8d-45a5-9d3b-0a8a11703882", "CreateDate": "2023-06-04T03:06:21.6536771-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2023-06-04T03:06:21.6536771-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "9d669162-e0fd-4b6e-8fdc-e94034445f1c", "CreateDate": "2023-06-04T03:06:21.6536771-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-06-04T03:06:21.6536771-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "89349b99-1a8b-489e-af87-c25e6b45c24e", "CreateDate": "2023-06-04T03:06:21.6536771-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2023-06-04T03:06:21.6536771-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "7a705657-8e84-4f5a-9601-0aadeff342e3", "EffectiveDate": "2023-06-04T03:06:21.6536771-07:00", "StatusType": { "StatusTypeId": "dc5e7a7d-4ef4-4fe2-b002-4b60065c7ff7", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "b96f4872-640b-441a-b1a6-e43a838a6069", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "f51c8437-8c8d-45a5-9d3b-0a8a11703882", "CreateDate": "2023-06-04T03:06:21.6536771-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2023-06-04T03:06:21.6536771-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "a48ccdcf-0444-444d-8e0a-a13997aaab8d", "CreateDate": "2023-06-04T03:06:21.6536771-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2023-06-04T03:06:21.6536771-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "1161781f-ac17-4366-ad64-77f689eb5cf4", "CreateDate": "2023-06-04T03:06:21.6536771-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2023-06-04T03:06:21.6536771-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2023-06-04T03:06:21.6536771-07:00", "MeasurementValueNeededDate": "2023-06-04T03:06:21.6536771-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "7abb119f-b01d-4d32-97d7-ccdad2439ca3", "CreateDate": "2023-06-04T03:06:21.6536771-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2023-06-04T03:06:21.6536771-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2023-06-04T03:06:21.6536771-07:00", "WellPurposeType": { "WellPurposeTypeId": "d01babc3-3544-4d48-954a-d2763f78b702", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "5f6dd51f-042e-4dff-a216-05636a107837", "CreateDate": "2023-06-04T03:06:21.6536771-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2023-06-04T03:06:21.6536771-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "680d3181-fcec-4ce6-b20a-42462654213b", "CreateDate": "2023-06-04T03:06:21.6536771-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2023-06-04T03:06:21.6693002-07:00", "LastModifiedUser": "sample string 4" }, { "WellPurposeId": "02c85f24-6414-4e52-8a12-b370623071ee", "Asset": { "AssetId": "a9cc47f7-a574-45c5-b614-8487e32edbae", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "b96f4872-640b-441a-b1a6-e43a838a6069", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "f51c8437-8c8d-45a5-9d3b-0a8a11703882", "CreateDate": "2023-06-04T03:06:21.6536771-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2023-06-04T03:06:21.6536771-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "738269d3-20a0-4167-964d-e8f71845c4e4", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2023-06-04T03:06:21.6536771-07:00", "MeasurementValueNeededDate": "2023-06-04T03:06:21.6536771-07:00", "SourceSystemId": "sample string 3", "CompanyId": "f69887e6-d4e1-4176-bad9-b7e89ccc6054", "CreateDate": "2023-06-04T03:06:21.6536771-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-06-04T03:06:21.6536771-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "00a55533-e15c-4b32-8829-3858c5ad9a63", "EffectiveDate": "2023-06-04T03:06:21.6536771-07:00", "StateType": { "StateTypeId": "1339c56c-513b-48b8-ab23-06f648279fb7", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "b96f4872-640b-441a-b1a6-e43a838a6069", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "f51c8437-8c8d-45a5-9d3b-0a8a11703882", "CreateDate": "2023-06-04T03:06:21.6536771-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2023-06-04T03:06:21.6536771-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "9d669162-e0fd-4b6e-8fdc-e94034445f1c", "CreateDate": "2023-06-04T03:06:21.6536771-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-06-04T03:06:21.6536771-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "89349b99-1a8b-489e-af87-c25e6b45c24e", "CreateDate": "2023-06-04T03:06:21.6536771-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2023-06-04T03:06:21.6536771-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "7a705657-8e84-4f5a-9601-0aadeff342e3", "EffectiveDate": "2023-06-04T03:06:21.6536771-07:00", "StatusType": { "StatusTypeId": "dc5e7a7d-4ef4-4fe2-b002-4b60065c7ff7", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "b96f4872-640b-441a-b1a6-e43a838a6069", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "f51c8437-8c8d-45a5-9d3b-0a8a11703882", "CreateDate": "2023-06-04T03:06:21.6536771-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2023-06-04T03:06:21.6536771-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "a48ccdcf-0444-444d-8e0a-a13997aaab8d", "CreateDate": "2023-06-04T03:06:21.6536771-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2023-06-04T03:06:21.6536771-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "1161781f-ac17-4366-ad64-77f689eb5cf4", "CreateDate": "2023-06-04T03:06:21.6536771-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2023-06-04T03:06:21.6536771-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2023-06-04T03:06:21.6536771-07:00", "MeasurementValueNeededDate": "2023-06-04T03:06:21.6536771-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "7abb119f-b01d-4d32-97d7-ccdad2439ca3", "CreateDate": "2023-06-04T03:06:21.6536771-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2023-06-04T03:06:21.6536771-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2023-06-04T03:06:21.6536771-07:00", "WellPurposeType": { "WellPurposeTypeId": "d01babc3-3544-4d48-954a-d2763f78b702", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "5f6dd51f-042e-4dff-a216-05636a107837", "CreateDate": "2023-06-04T03:06:21.6536771-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2023-06-04T03:06:21.6536771-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "680d3181-fcec-4ce6-b20a-42462654213b", "CreateDate": "2023-06-04T03:06:21.6536771-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2023-06-04T03:06:21.6693002-07:00", "LastModifiedUser": "sample string 4" } ], "Total": 1, "Message": "sample string 1" }