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": "47229986-d00a-4ab3-b788-03d6f8dfbff0", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "5fc57f49-9cf3-4d61-b8fa-85c86d767c9b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "1f03385e-8448-49cb-92d8-d5202774cd67", "CreateDate": "2024-07-26T20:05:30.6505069-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-07-26T20:05:30.6505069-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "e45a6512-972c-4248-928f-41fefcda63fa", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-07-26T20:05:30.6505069-07:00", "MeasurementValueNeededDate": "2024-07-26T20:05:30.6505069-07:00", "SourceSystemId": "sample string 3", "CompanyId": "e1c2694b-cae9-47e7-a1cd-3ad308327712", "CreateDate": "2024-07-26T20:05:30.6505069-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-07-26T20:05:30.6505069-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "100c9994-a07d-4bae-ad46-0e955c40848c", "EffectiveDate": "2024-07-26T20:05:30.6505069-07:00", "StateType": { "StateTypeId": "3681a579-1c22-43e3-94f6-e4f789bdc6bb", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "5fc57f49-9cf3-4d61-b8fa-85c86d767c9b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "1f03385e-8448-49cb-92d8-d5202774cd67", "CreateDate": "2024-07-26T20:05:30.6505069-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-07-26T20:05:30.6505069-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "45e0238f-e0f1-49d2-8ce9-5ef921918695", "CreateDate": "2024-07-26T20:05:30.6505069-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-07-26T20:05:30.6505069-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "2e2789f9-66a9-4431-8a13-375470751bbc", "CreateDate": "2024-07-26T20:05:30.6505069-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-07-26T20:05:30.6505069-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "e35a2c65-5710-49d9-b4fe-b43b7396a5bc", "EffectiveDate": "2024-07-26T20:05:30.6505069-07:00", "StatusType": { "StatusTypeId": "16136ca5-dc14-4c9a-bb87-545a5f0efef9", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "5fc57f49-9cf3-4d61-b8fa-85c86d767c9b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "1f03385e-8448-49cb-92d8-d5202774cd67", "CreateDate": "2024-07-26T20:05:30.6505069-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-07-26T20:05:30.6505069-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "053d8017-7892-45ae-a131-f175b52dd335", "CreateDate": "2024-07-26T20:05:30.6505069-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-07-26T20:05:30.6505069-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "d7f86464-5d0b-42b4-88fe-febd68d2fe49", "CreateDate": "2024-07-26T20:05:30.6505069-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-07-26T20:05:30.6505069-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "7c9ee590-7f74-4b52-b2f1-8d2171776dd7", "EffectiveDate": "2024-07-26T20:05:30.6505069-07:00", "WellPurposeType": { "WellPurposeTypeId": "b3bd99d9-1e1b-41d4-982d-c7e5a81a68b2", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "766bfa3f-e6b2-41b9-acb9-3e4f30b2f1e4", "CreateDate": "2024-07-26T20:05:30.6505069-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-07-26T20:05:30.6505069-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "299b7995-65be-4bdd-8729-efb535f05a6d", "CreateDate": "2024-07-26T20:05:30.6505069-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-07-26T20:05:30.6505069-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-07-26T20:05:30.6505069-07:00", "MeasurementValueNeededDate": "2024-07-26T20:05:30.6505069-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "abbeb308-dc16-4806-b480-87b5187d7768", "CreateDate": "2024-07-26T20:05:30.6505069-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-07-26T20:05:30.6505069-07:00", "LastModifiedUser": "sample string 8" }, { "AssetId": "47229986-d00a-4ab3-b788-03d6f8dfbff0", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "5fc57f49-9cf3-4d61-b8fa-85c86d767c9b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "1f03385e-8448-49cb-92d8-d5202774cd67", "CreateDate": "2024-07-26T20:05:30.6505069-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-07-26T20:05:30.6505069-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "e45a6512-972c-4248-928f-41fefcda63fa", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-07-26T20:05:30.6505069-07:00", "MeasurementValueNeededDate": "2024-07-26T20:05:30.6505069-07:00", "SourceSystemId": "sample string 3", "CompanyId": "e1c2694b-cae9-47e7-a1cd-3ad308327712", "CreateDate": "2024-07-26T20:05:30.6505069-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-07-26T20:05:30.6505069-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "100c9994-a07d-4bae-ad46-0e955c40848c", "EffectiveDate": "2024-07-26T20:05:30.6505069-07:00", "StateType": { "StateTypeId": "3681a579-1c22-43e3-94f6-e4f789bdc6bb", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "5fc57f49-9cf3-4d61-b8fa-85c86d767c9b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "1f03385e-8448-49cb-92d8-d5202774cd67", "CreateDate": "2024-07-26T20:05:30.6505069-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-07-26T20:05:30.6505069-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "45e0238f-e0f1-49d2-8ce9-5ef921918695", "CreateDate": "2024-07-26T20:05:30.6505069-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-07-26T20:05:30.6505069-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "2e2789f9-66a9-4431-8a13-375470751bbc", "CreateDate": "2024-07-26T20:05:30.6505069-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-07-26T20:05:30.6505069-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "e35a2c65-5710-49d9-b4fe-b43b7396a5bc", "EffectiveDate": "2024-07-26T20:05:30.6505069-07:00", "StatusType": { "StatusTypeId": "16136ca5-dc14-4c9a-bb87-545a5f0efef9", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "5fc57f49-9cf3-4d61-b8fa-85c86d767c9b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "1f03385e-8448-49cb-92d8-d5202774cd67", "CreateDate": "2024-07-26T20:05:30.6505069-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-07-26T20:05:30.6505069-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "053d8017-7892-45ae-a131-f175b52dd335", "CreateDate": "2024-07-26T20:05:30.6505069-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-07-26T20:05:30.6505069-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "d7f86464-5d0b-42b4-88fe-febd68d2fe49", "CreateDate": "2024-07-26T20:05:30.6505069-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-07-26T20:05:30.6505069-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "7c9ee590-7f74-4b52-b2f1-8d2171776dd7", "EffectiveDate": "2024-07-26T20:05:30.6505069-07:00", "WellPurposeType": { "WellPurposeTypeId": "b3bd99d9-1e1b-41d4-982d-c7e5a81a68b2", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "766bfa3f-e6b2-41b9-acb9-3e4f30b2f1e4", "CreateDate": "2024-07-26T20:05:30.6505069-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-07-26T20:05:30.6505069-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "299b7995-65be-4bdd-8729-efb535f05a6d", "CreateDate": "2024-07-26T20:05:30.6505069-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-07-26T20:05:30.6505069-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-07-26T20:05:30.6505069-07:00", "MeasurementValueNeededDate": "2024-07-26T20:05:30.6505069-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "abbeb308-dc16-4806-b480-87b5187d7768", "CreateDate": "2024-07-26T20:05:30.6505069-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-07-26T20:05:30.6505069-07:00", "LastModifiedUser": "sample string 8" } ], "Total": 1, "Message": "sample string 1" }