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": "ae5f832c-f6a5-4093-b296-0f507ad00d14",
"Asset": {
"AssetId": "97f6f9ae-5eac-45ae-92b8-641dc6187d01",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "17c42c6e-d69d-4a4f-b432-75a7807e4df1",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8d241030-8afb-4ded-a3c1-39e8a20d3bc7",
"CreateDate": "2025-07-03T18:26:47.2361071-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-03T18:26:47.2361071-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "8c3a33f4-9b99-4c5c-a123-4ca755fbf9db",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-07-03T18:26:47.2361071-07:00",
"MeasurementValueNeededDate": "2025-07-03T18:26:47.2361071-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8762dae6-f8e4-4ea0-92df-a66f27328eef",
"CreateDate": "2025-07-03T18:26:47.2361071-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-03T18:26:47.2361071-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "7e9ed889-ce09-4620-9c41-e5640e5f6f05",
"EffectiveDate": "2025-07-03T18:26:47.2361071-07:00",
"StateType": {
"StateTypeId": "100556c9-9e58-4348-8f37-bfb650b697f7",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "17c42c6e-d69d-4a4f-b432-75a7807e4df1",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8d241030-8afb-4ded-a3c1-39e8a20d3bc7",
"CreateDate": "2025-07-03T18:26:47.2361071-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-03T18:26:47.2361071-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "b410fc25-4c30-4269-bf9e-51af93b0a03b",
"CreateDate": "2025-07-03T18:26:47.2361071-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-03T18:26:47.2361071-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "fa259473-011b-4551-8cee-295c7ef93fe9",
"CreateDate": "2025-07-03T18:26:47.2361071-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-03T18:26:47.2361071-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "cd55ac5c-9333-4fb0-bedc-3e9d549149cb",
"EffectiveDate": "2025-07-03T18:26:47.2361071-07:00",
"StatusType": {
"StatusTypeId": "1751c258-578c-4def-bf3c-5bd34eb5e76b",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "17c42c6e-d69d-4a4f-b432-75a7807e4df1",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8d241030-8afb-4ded-a3c1-39e8a20d3bc7",
"CreateDate": "2025-07-03T18:26:47.2361071-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-03T18:26:47.2361071-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "22b50ad8-8bd6-4050-b856-edf824ae58cc",
"CreateDate": "2025-07-03T18:26:47.2361071-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-03T18:26:47.2361071-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "eb963b54-5dd3-4d18-8e16-33886095c3a9",
"CreateDate": "2025-07-03T18:26:47.2361071-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-03T18:26:47.2361071-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-07-03T18:26:47.2361071-07:00",
"MeasurementValueNeededDate": "2025-07-03T18:26:47.2361071-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "99c60b01-2e3c-474c-b67f-b5044ad8acdf",
"CreateDate": "2025-07-03T18:26:47.2361071-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-03T18:26:47.2361071-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2025-07-03T18:26:47.2361071-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "02df2c07-149b-4f54-9e4b-e82fac09c3d5",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c2e1626a-0f80-413d-b8c3-4e33879c3ee4",
"CreateDate": "2025-07-03T18:26:47.2361071-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-03T18:26:47.2361071-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "fbecf642-2be3-496d-903a-3c6f753060b6",
"CreateDate": "2025-07-03T18:26:47.2361071-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-03T18:26:47.2361071-07:00",
"LastModifiedUser": "sample string 4"
},
{
"WellPurposeId": "ae5f832c-f6a5-4093-b296-0f507ad00d14",
"Asset": {
"AssetId": "97f6f9ae-5eac-45ae-92b8-641dc6187d01",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "17c42c6e-d69d-4a4f-b432-75a7807e4df1",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8d241030-8afb-4ded-a3c1-39e8a20d3bc7",
"CreateDate": "2025-07-03T18:26:47.2361071-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-03T18:26:47.2361071-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "8c3a33f4-9b99-4c5c-a123-4ca755fbf9db",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-07-03T18:26:47.2361071-07:00",
"MeasurementValueNeededDate": "2025-07-03T18:26:47.2361071-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8762dae6-f8e4-4ea0-92df-a66f27328eef",
"CreateDate": "2025-07-03T18:26:47.2361071-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-03T18:26:47.2361071-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "7e9ed889-ce09-4620-9c41-e5640e5f6f05",
"EffectiveDate": "2025-07-03T18:26:47.2361071-07:00",
"StateType": {
"StateTypeId": "100556c9-9e58-4348-8f37-bfb650b697f7",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "17c42c6e-d69d-4a4f-b432-75a7807e4df1",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8d241030-8afb-4ded-a3c1-39e8a20d3bc7",
"CreateDate": "2025-07-03T18:26:47.2361071-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-03T18:26:47.2361071-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "b410fc25-4c30-4269-bf9e-51af93b0a03b",
"CreateDate": "2025-07-03T18:26:47.2361071-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-03T18:26:47.2361071-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "fa259473-011b-4551-8cee-295c7ef93fe9",
"CreateDate": "2025-07-03T18:26:47.2361071-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-03T18:26:47.2361071-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "cd55ac5c-9333-4fb0-bedc-3e9d549149cb",
"EffectiveDate": "2025-07-03T18:26:47.2361071-07:00",
"StatusType": {
"StatusTypeId": "1751c258-578c-4def-bf3c-5bd34eb5e76b",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "17c42c6e-d69d-4a4f-b432-75a7807e4df1",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8d241030-8afb-4ded-a3c1-39e8a20d3bc7",
"CreateDate": "2025-07-03T18:26:47.2361071-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-03T18:26:47.2361071-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "22b50ad8-8bd6-4050-b856-edf824ae58cc",
"CreateDate": "2025-07-03T18:26:47.2361071-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-03T18:26:47.2361071-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "eb963b54-5dd3-4d18-8e16-33886095c3a9",
"CreateDate": "2025-07-03T18:26:47.2361071-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-03T18:26:47.2361071-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-07-03T18:26:47.2361071-07:00",
"MeasurementValueNeededDate": "2025-07-03T18:26:47.2361071-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "99c60b01-2e3c-474c-b67f-b5044ad8acdf",
"CreateDate": "2025-07-03T18:26:47.2361071-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-03T18:26:47.2361071-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2025-07-03T18:26:47.2361071-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "02df2c07-149b-4f54-9e4b-e82fac09c3d5",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c2e1626a-0f80-413d-b8c3-4e33879c3ee4",
"CreateDate": "2025-07-03T18:26:47.2361071-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-03T18:26:47.2361071-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "fbecf642-2be3-496d-903a-3c6f753060b6",
"CreateDate": "2025-07-03T18:26:47.2361071-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-03T18:26:47.2361071-07:00",
"LastModifiedUser": "sample string 4"
}
],
"Total": 1,
"Message": "sample string 1"
}