GET Assets?assetTypeId={assetTypeId}&assetGroupId={assetGroupId}&parentAssetId={parentAssetId}&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 assets for the given parameters. All parameters are optional.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| assetTypeId |
Id of the asset type |
globally unique identifier |
None. |
| assetGroupId |
Id of the asset group |
globally unique identifier |
None. |
| parentAssetId |
Id of the parent asset |
globally unique identifier |
None. |
| take |
Number of assets to retrieve. Default is all assets |
integer |
None. |
| skip |
Number of assets to skip before retrieval |
integer |
Default value is 0 |
| sort |
List of sorting rules to describe how to sort the assets 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 assets.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Collection of Asset |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": [
{
"AssetId": "0d784da8-5fe6-4a2a-ac22-5a5257c1cd12",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "5789ff80-a12c-45c0-9e41-92f4a20e9be4",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "72c441ab-24f9-4d8d-b369-4ead6d07d296",
"CreateDate": "2025-07-12T02:21:48.9144441-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-12T02:21:48.9144441-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "cfd66bee-44cd-4630-9ecd-82bb742fbba5",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-07-12T02:21:48.9144441-07:00",
"MeasurementValueNeededDate": "2025-07-12T02:21:48.9144441-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "bc4bc5a7-35c7-4c7b-9a1b-89d0076b61bb",
"CreateDate": "2025-07-12T02:21:48.9144441-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-12T02:21:48.9144441-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "b09e8baa-f0f1-40e9-862f-c72e8241c3d4",
"EffectiveDate": "2025-07-12T02:21:48.9144441-07:00",
"StateType": {
"StateTypeId": "ee4537f4-e951-44b2-9b40-19ae58422bc5",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "5789ff80-a12c-45c0-9e41-92f4a20e9be4",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "72c441ab-24f9-4d8d-b369-4ead6d07d296",
"CreateDate": "2025-07-12T02:21:48.9144441-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-12T02:21:48.9144441-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "207a8848-58ff-4963-8629-4f36d4ed0f96",
"CreateDate": "2025-07-12T02:21:48.9144441-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-12T02:21:48.9144441-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "bde3eca0-8aab-4746-984a-c9ac917459c0",
"CreateDate": "2025-07-12T02:21:48.9144441-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-12T02:21:48.9144441-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "7e296210-9033-462d-ac98-84cbff1270ec",
"EffectiveDate": "2025-07-12T02:21:48.9144441-07:00",
"StatusType": {
"StatusTypeId": "e2b3ff18-181a-4d76-83fd-5e55132e4258",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "5789ff80-a12c-45c0-9e41-92f4a20e9be4",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "72c441ab-24f9-4d8d-b369-4ead6d07d296",
"CreateDate": "2025-07-12T02:21:48.9144441-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-12T02:21:48.9144441-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "0d86b173-5365-47f2-a1d9-9a64fb879285",
"CreateDate": "2025-07-12T02:21:48.9144441-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-12T02:21:48.9144441-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6cb0838f-7e3e-4619-92bc-6cf8d5441cd5",
"CreateDate": "2025-07-12T02:21:48.9144441-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-12T02:21:48.9144441-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "47db2fe2-4a41-422e-84aa-1c24c1b1f9de",
"EffectiveDate": "2025-07-12T02:21:48.9144441-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "32930aae-c8b3-4f39-afc2-cd2439e5779b",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "39ef1728-f74a-45ad-9381-6c74548baf7f",
"CreateDate": "2025-07-12T02:21:48.9144441-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-12T02:21:48.9144441-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c1600f6f-9446-4532-b484-df7c1c3d50bb",
"CreateDate": "2025-07-12T02:21:48.9144441-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-12T02:21:48.9144441-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-07-12T02:21:48.9144441-07:00",
"MeasurementValueNeededDate": "2025-07-12T02:21:48.9144441-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "ab77a0d9-82e6-4c45-93f2-80762444cfed",
"CreateDate": "2025-07-12T02:21:48.9144441-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-12T02:21:48.9144441-07:00",
"LastModifiedUser": "sample string 8"
},
{
"AssetId": "0d784da8-5fe6-4a2a-ac22-5a5257c1cd12",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "5789ff80-a12c-45c0-9e41-92f4a20e9be4",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "72c441ab-24f9-4d8d-b369-4ead6d07d296",
"CreateDate": "2025-07-12T02:21:48.9144441-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-12T02:21:48.9144441-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "cfd66bee-44cd-4630-9ecd-82bb742fbba5",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-07-12T02:21:48.9144441-07:00",
"MeasurementValueNeededDate": "2025-07-12T02:21:48.9144441-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "bc4bc5a7-35c7-4c7b-9a1b-89d0076b61bb",
"CreateDate": "2025-07-12T02:21:48.9144441-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-12T02:21:48.9144441-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "b09e8baa-f0f1-40e9-862f-c72e8241c3d4",
"EffectiveDate": "2025-07-12T02:21:48.9144441-07:00",
"StateType": {
"StateTypeId": "ee4537f4-e951-44b2-9b40-19ae58422bc5",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "5789ff80-a12c-45c0-9e41-92f4a20e9be4",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "72c441ab-24f9-4d8d-b369-4ead6d07d296",
"CreateDate": "2025-07-12T02:21:48.9144441-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-12T02:21:48.9144441-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "207a8848-58ff-4963-8629-4f36d4ed0f96",
"CreateDate": "2025-07-12T02:21:48.9144441-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-12T02:21:48.9144441-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "bde3eca0-8aab-4746-984a-c9ac917459c0",
"CreateDate": "2025-07-12T02:21:48.9144441-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-12T02:21:48.9144441-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "7e296210-9033-462d-ac98-84cbff1270ec",
"EffectiveDate": "2025-07-12T02:21:48.9144441-07:00",
"StatusType": {
"StatusTypeId": "e2b3ff18-181a-4d76-83fd-5e55132e4258",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "5789ff80-a12c-45c0-9e41-92f4a20e9be4",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "72c441ab-24f9-4d8d-b369-4ead6d07d296",
"CreateDate": "2025-07-12T02:21:48.9144441-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-12T02:21:48.9144441-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "0d86b173-5365-47f2-a1d9-9a64fb879285",
"CreateDate": "2025-07-12T02:21:48.9144441-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-12T02:21:48.9144441-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6cb0838f-7e3e-4619-92bc-6cf8d5441cd5",
"CreateDate": "2025-07-12T02:21:48.9144441-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-12T02:21:48.9144441-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "47db2fe2-4a41-422e-84aa-1c24c1b1f9de",
"EffectiveDate": "2025-07-12T02:21:48.9144441-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "32930aae-c8b3-4f39-afc2-cd2439e5779b",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "39ef1728-f74a-45ad-9381-6c74548baf7f",
"CreateDate": "2025-07-12T02:21:48.9144441-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-12T02:21:48.9144441-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c1600f6f-9446-4532-b484-df7c1c3d50bb",
"CreateDate": "2025-07-12T02:21:48.9144441-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-12T02:21:48.9144441-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-07-12T02:21:48.9144441-07:00",
"MeasurementValueNeededDate": "2025-07-12T02:21:48.9144441-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "ab77a0d9-82e6-4c45-93f2-80762444cfed",
"CreateDate": "2025-07-12T02:21:48.9144441-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-12T02:21:48.9144441-07:00",
"LastModifiedUser": "sample string 8"
}
],
"Total": 1,
"Message": "sample string 1"
}