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": "4d3e315b-d724-47c1-b149-7c9952078392",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "40e288ea-35d2-4ede-b8c7-d7f5197eb292",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "72ac9ad8-8ad4-4cf0-a825-e675764d990a",
"CreateDate": "2025-04-25T15:12:10.789483-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-25T15:12:10.789483-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "e1f7d775-7e45-44f4-aee3-b88f7d6196ad",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-04-25T15:12:10.789483-07:00",
"MeasurementValueNeededDate": "2025-04-25T15:12:10.789483-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "190450ff-4c33-441b-a422-815f665e3f81",
"CreateDate": "2025-04-25T15:12:10.789483-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-25T15:12:10.789483-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "1e9b0fe4-f1dd-4e09-9105-000adc38ff75",
"EffectiveDate": "2025-04-25T15:12:10.789483-07:00",
"StateType": {
"StateTypeId": "36e59a00-c4e6-499b-951a-a289ba7d5c8d",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "40e288ea-35d2-4ede-b8c7-d7f5197eb292",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "72ac9ad8-8ad4-4cf0-a825-e675764d990a",
"CreateDate": "2025-04-25T15:12:10.789483-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-25T15:12:10.789483-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "8b664546-5025-48eb-8cdb-6b95b0f469ff",
"CreateDate": "2025-04-25T15:12:10.789483-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-25T15:12:10.789483-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2fdbb7c1-900a-4c86-92d3-b75d473bd660",
"CreateDate": "2025-04-25T15:12:10.789483-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-25T15:12:10.789483-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "05544968-4e55-4335-8b6a-8d10fb8d411a",
"EffectiveDate": "2025-04-25T15:12:10.789483-07:00",
"StatusType": {
"StatusTypeId": "4a40f789-2b01-44e0-b630-a2fd703d5f44",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "40e288ea-35d2-4ede-b8c7-d7f5197eb292",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "72ac9ad8-8ad4-4cf0-a825-e675764d990a",
"CreateDate": "2025-04-25T15:12:10.789483-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-25T15:12:10.789483-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "339bba44-cae0-4e0d-991e-5e01058ac72c",
"CreateDate": "2025-04-25T15:12:10.789483-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-25T15:12:10.789483-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "27492b37-0229-439d-8ac8-3d7ae8f9d6e3",
"CreateDate": "2025-04-25T15:12:10.789483-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-25T15:12:10.789483-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "1a147e54-5613-4cbd-a719-62877374f5b2",
"EffectiveDate": "2025-04-25T15:12:10.789483-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "db0f3b0a-0350-4448-905b-e4bc9e10876e",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "8c1c3559-5b3e-497e-97de-5d92a279404c",
"CreateDate": "2025-04-25T15:12:10.789483-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-25T15:12:10.789483-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "af59ad73-0006-4349-b8c8-585dc3a2adfd",
"CreateDate": "2025-04-25T15:12:10.789483-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-25T15:12:10.789483-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-04-25T15:12:10.789483-07:00",
"MeasurementValueNeededDate": "2025-04-25T15:12:10.789483-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "a1108e18-2212-413c-bf00-a5cbaa1bd7f0",
"CreateDate": "2025-04-25T15:12:10.789483-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-25T15:12:10.789483-07:00",
"LastModifiedUser": "sample string 8"
},
{
"AssetId": "4d3e315b-d724-47c1-b149-7c9952078392",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "40e288ea-35d2-4ede-b8c7-d7f5197eb292",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "72ac9ad8-8ad4-4cf0-a825-e675764d990a",
"CreateDate": "2025-04-25T15:12:10.789483-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-25T15:12:10.789483-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "e1f7d775-7e45-44f4-aee3-b88f7d6196ad",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-04-25T15:12:10.789483-07:00",
"MeasurementValueNeededDate": "2025-04-25T15:12:10.789483-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "190450ff-4c33-441b-a422-815f665e3f81",
"CreateDate": "2025-04-25T15:12:10.789483-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-25T15:12:10.789483-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "1e9b0fe4-f1dd-4e09-9105-000adc38ff75",
"EffectiveDate": "2025-04-25T15:12:10.789483-07:00",
"StateType": {
"StateTypeId": "36e59a00-c4e6-499b-951a-a289ba7d5c8d",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "40e288ea-35d2-4ede-b8c7-d7f5197eb292",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "72ac9ad8-8ad4-4cf0-a825-e675764d990a",
"CreateDate": "2025-04-25T15:12:10.789483-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-25T15:12:10.789483-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "8b664546-5025-48eb-8cdb-6b95b0f469ff",
"CreateDate": "2025-04-25T15:12:10.789483-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-25T15:12:10.789483-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2fdbb7c1-900a-4c86-92d3-b75d473bd660",
"CreateDate": "2025-04-25T15:12:10.789483-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-25T15:12:10.789483-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "05544968-4e55-4335-8b6a-8d10fb8d411a",
"EffectiveDate": "2025-04-25T15:12:10.789483-07:00",
"StatusType": {
"StatusTypeId": "4a40f789-2b01-44e0-b630-a2fd703d5f44",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "40e288ea-35d2-4ede-b8c7-d7f5197eb292",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "72ac9ad8-8ad4-4cf0-a825-e675764d990a",
"CreateDate": "2025-04-25T15:12:10.789483-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-25T15:12:10.789483-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "339bba44-cae0-4e0d-991e-5e01058ac72c",
"CreateDate": "2025-04-25T15:12:10.789483-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-25T15:12:10.789483-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "27492b37-0229-439d-8ac8-3d7ae8f9d6e3",
"CreateDate": "2025-04-25T15:12:10.789483-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-25T15:12:10.789483-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "1a147e54-5613-4cbd-a719-62877374f5b2",
"EffectiveDate": "2025-04-25T15:12:10.789483-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "db0f3b0a-0350-4448-905b-e4bc9e10876e",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "8c1c3559-5b3e-497e-97de-5d92a279404c",
"CreateDate": "2025-04-25T15:12:10.789483-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-25T15:12:10.789483-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "af59ad73-0006-4349-b8c8-585dc3a2adfd",
"CreateDate": "2025-04-25T15:12:10.789483-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-25T15:12:10.789483-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-04-25T15:12:10.789483-07:00",
"MeasurementValueNeededDate": "2025-04-25T15:12:10.789483-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "a1108e18-2212-413c-bf00-a5cbaa1bd7f0",
"CreateDate": "2025-04-25T15:12:10.789483-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-25T15:12:10.789483-07:00",
"LastModifiedUser": "sample string 8"
}
],
"Total": 1,
"Message": "sample string 1"
}