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": "bc4b2a72-2e16-414e-9f5c-607f3b279c85",
"Asset": {
"AssetId": "319b50b5-bddf-43b1-988f-207fddfc80f0",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "f7c6573f-ef08-4fca-9a1d-d4bfeacd1b32",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1265cc49-494d-4d4d-b555-2c8248b7e9c8",
"CreateDate": "2026-06-13T11:09:37.4143849-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-13T11:09:37.4143849-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "9dec9e49-ad87-4e66-8cd6-7a2c3f392257",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-13T11:09:37.4143849-07:00",
"MeasurementValueNeededDate": "2026-06-13T11:09:37.4143849-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5ba188e2-2569-42fc-89a8-7debae2941cf",
"CreateDate": "2026-06-13T11:09:37.4143849-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-13T11:09:37.4143849-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "3bd0605b-4967-48dd-85a7-6f249581bc6c",
"EffectiveDate": "2026-06-13T11:09:37.4143849-07:00",
"StateType": {
"StateTypeId": "30b11796-d1ad-4415-888d-a6401a8452ad",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "f7c6573f-ef08-4fca-9a1d-d4bfeacd1b32",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1265cc49-494d-4d4d-b555-2c8248b7e9c8",
"CreateDate": "2026-06-13T11:09:37.4143849-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-13T11:09:37.4143849-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "e4a3b36e-47e8-438f-8767-524d44753cce",
"CreateDate": "2026-06-13T11:09:37.4143849-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-13T11:09:37.4143849-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "beb4394b-831a-41d2-85df-a28ecf19ecd7",
"CreateDate": "2026-06-13T11:09:37.4143849-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-13T11:09:37.4143849-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "11d2db72-fb0f-41a3-99ac-aad37c92a195",
"EffectiveDate": "2026-06-13T11:09:37.4143849-07:00",
"StatusType": {
"StatusTypeId": "087c8f93-36f3-4474-be7f-03b814cefbe9",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "f7c6573f-ef08-4fca-9a1d-d4bfeacd1b32",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1265cc49-494d-4d4d-b555-2c8248b7e9c8",
"CreateDate": "2026-06-13T11:09:37.4143849-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-13T11:09:37.4143849-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "3a60d753-e82a-402c-ae98-d5eb6213a75c",
"CreateDate": "2026-06-13T11:09:37.4143849-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-13T11:09:37.4143849-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "dee1c2e4-559e-4ed0-81dd-bd03671cd4b3",
"CreateDate": "2026-06-13T11:09:37.4143849-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-13T11:09:37.4143849-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-06-13T11:09:37.4143849-07:00",
"MeasurementValueNeededDate": "2026-06-13T11:09:37.4143849-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "86058962-c152-4c0e-ac13-da1cd5772ee6",
"CreateDate": "2026-06-13T11:09:37.4143849-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-13T11:09:37.4143849-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2026-06-13T11:09:37.4143849-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "4777ffb7-5c0c-459b-9336-e802454f29c9",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b045d6cc-d2e5-4517-a5d7-f37b98c9168a",
"CreateDate": "2026-06-13T11:09:37.4143849-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-13T11:09:37.4143849-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d45b80b1-038f-4aef-80b2-3b1de291c587",
"CreateDate": "2026-06-13T11:09:37.4143849-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-13T11:09:37.4143849-07:00",
"LastModifiedUser": "sample string 4"
},
{
"WellPurposeId": "bc4b2a72-2e16-414e-9f5c-607f3b279c85",
"Asset": {
"AssetId": "319b50b5-bddf-43b1-988f-207fddfc80f0",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "f7c6573f-ef08-4fca-9a1d-d4bfeacd1b32",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1265cc49-494d-4d4d-b555-2c8248b7e9c8",
"CreateDate": "2026-06-13T11:09:37.4143849-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-13T11:09:37.4143849-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "9dec9e49-ad87-4e66-8cd6-7a2c3f392257",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-13T11:09:37.4143849-07:00",
"MeasurementValueNeededDate": "2026-06-13T11:09:37.4143849-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5ba188e2-2569-42fc-89a8-7debae2941cf",
"CreateDate": "2026-06-13T11:09:37.4143849-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-13T11:09:37.4143849-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "3bd0605b-4967-48dd-85a7-6f249581bc6c",
"EffectiveDate": "2026-06-13T11:09:37.4143849-07:00",
"StateType": {
"StateTypeId": "30b11796-d1ad-4415-888d-a6401a8452ad",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "f7c6573f-ef08-4fca-9a1d-d4bfeacd1b32",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1265cc49-494d-4d4d-b555-2c8248b7e9c8",
"CreateDate": "2026-06-13T11:09:37.4143849-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-13T11:09:37.4143849-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "e4a3b36e-47e8-438f-8767-524d44753cce",
"CreateDate": "2026-06-13T11:09:37.4143849-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-13T11:09:37.4143849-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "beb4394b-831a-41d2-85df-a28ecf19ecd7",
"CreateDate": "2026-06-13T11:09:37.4143849-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-13T11:09:37.4143849-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "11d2db72-fb0f-41a3-99ac-aad37c92a195",
"EffectiveDate": "2026-06-13T11:09:37.4143849-07:00",
"StatusType": {
"StatusTypeId": "087c8f93-36f3-4474-be7f-03b814cefbe9",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "f7c6573f-ef08-4fca-9a1d-d4bfeacd1b32",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1265cc49-494d-4d4d-b555-2c8248b7e9c8",
"CreateDate": "2026-06-13T11:09:37.4143849-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-13T11:09:37.4143849-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "3a60d753-e82a-402c-ae98-d5eb6213a75c",
"CreateDate": "2026-06-13T11:09:37.4143849-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-13T11:09:37.4143849-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "dee1c2e4-559e-4ed0-81dd-bd03671cd4b3",
"CreateDate": "2026-06-13T11:09:37.4143849-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-13T11:09:37.4143849-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-06-13T11:09:37.4143849-07:00",
"MeasurementValueNeededDate": "2026-06-13T11:09:37.4143849-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "86058962-c152-4c0e-ac13-da1cd5772ee6",
"CreateDate": "2026-06-13T11:09:37.4143849-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-13T11:09:37.4143849-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2026-06-13T11:09:37.4143849-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "4777ffb7-5c0c-459b-9336-e802454f29c9",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b045d6cc-d2e5-4517-a5d7-f37b98c9168a",
"CreateDate": "2026-06-13T11:09:37.4143849-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-13T11:09:37.4143849-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d45b80b1-038f-4aef-80b2-3b1de291c587",
"CreateDate": "2026-06-13T11:09:37.4143849-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-13T11:09:37.4143849-07:00",
"LastModifiedUser": "sample string 4"
}
],
"Total": 1,
"Message": "sample string 1"
}