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": "c3d4d2b1-3eb2-40bb-bc1a-b9eaa9a44c44",
"Asset": {
"AssetId": "6d17327d-36d5-48fe-8e3a-4a539aa729fe",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "77e66e8e-a099-4a78-a43f-33132ae12049",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "dc2e6c1f-b74a-42ec-9b1b-66e543a73ba4",
"CreateDate": "2025-07-18T23:51:16.3506084-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-18T23:51:16.3506084-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "bba2f0ef-8698-47d8-97d6-086384606dbc",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-07-18T23:51:16.3506084-07:00",
"MeasurementValueNeededDate": "2025-07-18T23:51:16.3506084-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "16e8f87e-1c9d-4332-8626-a54c5fb25b0b",
"CreateDate": "2025-07-18T23:51:16.3506084-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-18T23:51:16.3506084-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "802d4274-8b3c-4099-a525-609631e78db8",
"EffectiveDate": "2025-07-18T23:51:16.3506084-07:00",
"StateType": {
"StateTypeId": "6c5e5d77-cb93-4390-aa7a-f4e0984d0351",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "77e66e8e-a099-4a78-a43f-33132ae12049",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "dc2e6c1f-b74a-42ec-9b1b-66e543a73ba4",
"CreateDate": "2025-07-18T23:51:16.3506084-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-18T23:51:16.3506084-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "71c168ce-fd3e-4f60-a78f-257609fa5212",
"CreateDate": "2025-07-18T23:51:16.3506084-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-18T23:51:16.3506084-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "fa401de1-6eb9-4e5a-9715-c90d51756376",
"CreateDate": "2025-07-18T23:51:16.3506084-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-18T23:51:16.3506084-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "cba1fdae-aa6d-4e63-96c3-8d8da66677ba",
"EffectiveDate": "2025-07-18T23:51:16.3506084-07:00",
"StatusType": {
"StatusTypeId": "765e48de-9dad-473e-a824-d1992a4e36ec",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "77e66e8e-a099-4a78-a43f-33132ae12049",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "dc2e6c1f-b74a-42ec-9b1b-66e543a73ba4",
"CreateDate": "2025-07-18T23:51:16.3506084-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-18T23:51:16.3506084-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "b50bc5b9-c202-405b-a368-0ce6c0f252c6",
"CreateDate": "2025-07-18T23:51:16.3506084-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-18T23:51:16.3506084-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9769bc10-fe30-4ae4-a202-8c9b75a77a9f",
"CreateDate": "2025-07-18T23:51:16.3506084-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-18T23:51:16.3506084-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-07-18T23:51:16.3506084-07:00",
"MeasurementValueNeededDate": "2025-07-18T23:51:16.3506084-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "bd5f3938-7a9c-46e6-bebd-be172afd0a20",
"CreateDate": "2025-07-18T23:51:16.3506084-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-18T23:51:16.3506084-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2025-07-18T23:51:16.3506084-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "85fa11a0-32a1-4a53-b9cc-449d3ccf40dc",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b9318a4b-5ae3-45c9-a343-6a3e0c0634e6",
"CreateDate": "2025-07-18T23:51:16.3506084-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-18T23:51:16.3506084-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "624b6a85-4737-4f6a-a37b-f7260be60eb9",
"CreateDate": "2025-07-18T23:51:16.3506084-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-18T23:51:16.3506084-07:00",
"LastModifiedUser": "sample string 4"
},
{
"WellPurposeId": "c3d4d2b1-3eb2-40bb-bc1a-b9eaa9a44c44",
"Asset": {
"AssetId": "6d17327d-36d5-48fe-8e3a-4a539aa729fe",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "77e66e8e-a099-4a78-a43f-33132ae12049",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "dc2e6c1f-b74a-42ec-9b1b-66e543a73ba4",
"CreateDate": "2025-07-18T23:51:16.3506084-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-18T23:51:16.3506084-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "bba2f0ef-8698-47d8-97d6-086384606dbc",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-07-18T23:51:16.3506084-07:00",
"MeasurementValueNeededDate": "2025-07-18T23:51:16.3506084-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "16e8f87e-1c9d-4332-8626-a54c5fb25b0b",
"CreateDate": "2025-07-18T23:51:16.3506084-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-18T23:51:16.3506084-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "802d4274-8b3c-4099-a525-609631e78db8",
"EffectiveDate": "2025-07-18T23:51:16.3506084-07:00",
"StateType": {
"StateTypeId": "6c5e5d77-cb93-4390-aa7a-f4e0984d0351",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "77e66e8e-a099-4a78-a43f-33132ae12049",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "dc2e6c1f-b74a-42ec-9b1b-66e543a73ba4",
"CreateDate": "2025-07-18T23:51:16.3506084-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-18T23:51:16.3506084-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "71c168ce-fd3e-4f60-a78f-257609fa5212",
"CreateDate": "2025-07-18T23:51:16.3506084-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-18T23:51:16.3506084-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "fa401de1-6eb9-4e5a-9715-c90d51756376",
"CreateDate": "2025-07-18T23:51:16.3506084-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-18T23:51:16.3506084-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "cba1fdae-aa6d-4e63-96c3-8d8da66677ba",
"EffectiveDate": "2025-07-18T23:51:16.3506084-07:00",
"StatusType": {
"StatusTypeId": "765e48de-9dad-473e-a824-d1992a4e36ec",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "77e66e8e-a099-4a78-a43f-33132ae12049",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "dc2e6c1f-b74a-42ec-9b1b-66e543a73ba4",
"CreateDate": "2025-07-18T23:51:16.3506084-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-18T23:51:16.3506084-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "b50bc5b9-c202-405b-a368-0ce6c0f252c6",
"CreateDate": "2025-07-18T23:51:16.3506084-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-18T23:51:16.3506084-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9769bc10-fe30-4ae4-a202-8c9b75a77a9f",
"CreateDate": "2025-07-18T23:51:16.3506084-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-18T23:51:16.3506084-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-07-18T23:51:16.3506084-07:00",
"MeasurementValueNeededDate": "2025-07-18T23:51:16.3506084-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "bd5f3938-7a9c-46e6-bebd-be172afd0a20",
"CreateDate": "2025-07-18T23:51:16.3506084-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-18T23:51:16.3506084-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2025-07-18T23:51:16.3506084-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "85fa11a0-32a1-4a53-b9cc-449d3ccf40dc",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b9318a4b-5ae3-45c9-a343-6a3e0c0634e6",
"CreateDate": "2025-07-18T23:51:16.3506084-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-18T23:51:16.3506084-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "624b6a85-4737-4f6a-a37b-f7260be60eb9",
"CreateDate": "2025-07-18T23:51:16.3506084-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-18T23:51:16.3506084-07:00",
"LastModifiedUser": "sample string 4"
}
],
"Total": 1,
"Message": "sample string 1"
}