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": "77984f6b-c0a5-421e-8781-190adfedeaf0", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "1dbfd156-4048-4549-9ab8-3ba427ad7840", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "74d4f566-d512-4296-ad0e-95e0ac7762ec", "CreateDate": "2023-06-04T03:56:24.3968346-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2023-06-04T03:56:24.3968346-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "7e5ab325-216a-443b-8819-be62f994e97d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2023-06-04T03:56:24.3968346-07:00", "MeasurementValueNeededDate": "2023-06-04T03:56:24.3968346-07:00", "SourceSystemId": "sample string 3", "CompanyId": "565161b9-d71d-4914-a851-72e06f7ca3ce", "CreateDate": "2023-06-04T03:56:24.3968346-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-06-04T03:56:24.3968346-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "3f8417d1-11ff-4464-a7af-b1fb5f85e36f", "EffectiveDate": "2023-06-04T03:56:24.3968346-07:00", "StateType": { "StateTypeId": "96618bc3-376a-4cb7-9ab6-f38674a5ccb9", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "1dbfd156-4048-4549-9ab8-3ba427ad7840", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "74d4f566-d512-4296-ad0e-95e0ac7762ec", "CreateDate": "2023-06-04T03:56:24.3968346-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2023-06-04T03:56:24.3968346-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "af2d2526-8138-416e-9900-d06df140fcda", "CreateDate": "2023-06-04T03:56:24.3968346-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-06-04T03:56:24.3968346-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "2291d70a-e504-44e5-9153-a207f204ab47", "CreateDate": "2023-06-04T03:56:24.3968346-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2023-06-04T03:56:24.3968346-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "8d830880-ff51-4979-b0f8-c6a35f642c97", "EffectiveDate": "2023-06-04T03:56:24.3968346-07:00", "StatusType": { "StatusTypeId": "8e994972-c83f-49d3-a045-7b9a9dd8667c", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "1dbfd156-4048-4549-9ab8-3ba427ad7840", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "74d4f566-d512-4296-ad0e-95e0ac7762ec", "CreateDate": "2023-06-04T03:56:24.3968346-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2023-06-04T03:56:24.3968346-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "ec701f4e-722c-4de4-b0bd-d563758446b0", "CreateDate": "2023-06-04T03:56:24.3968346-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2023-06-04T03:56:24.3968346-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "ae01bd58-e080-4fcb-9ed3-5266db634ecf", "CreateDate": "2023-06-04T03:56:24.3968346-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2023-06-04T03:56:24.3968346-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "b37fefa5-2d77-4be5-a279-a2858ba94f28", "EffectiveDate": "2023-06-04T03:56:24.3968346-07:00", "WellPurposeType": { "WellPurposeTypeId": "6320375b-7006-48a9-a2b3-483947fe8266", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "6178cf32-1d4a-41f1-a2b2-6601c3dbe6c2", "CreateDate": "2023-06-04T03:56:24.3968346-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2023-06-04T03:56:24.3968346-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "4c13e226-e442-4809-92d2-fc06a6b94aca", "CreateDate": "2023-06-04T03:56:24.3968346-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2023-06-04T03:56:24.3968346-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2023-06-04T03:56:24.3968346-07:00", "MeasurementValueNeededDate": "2023-06-04T03:56:24.3968346-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "db4b048d-92bf-4eaa-a2b9-f9c692f34346", "CreateDate": "2023-06-04T03:56:24.3968346-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2023-06-04T03:56:24.3968346-07:00", "LastModifiedUser": "sample string 8" }, { "AssetId": "77984f6b-c0a5-421e-8781-190adfedeaf0", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "1dbfd156-4048-4549-9ab8-3ba427ad7840", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "74d4f566-d512-4296-ad0e-95e0ac7762ec", "CreateDate": "2023-06-04T03:56:24.3968346-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2023-06-04T03:56:24.3968346-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "7e5ab325-216a-443b-8819-be62f994e97d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2023-06-04T03:56:24.3968346-07:00", "MeasurementValueNeededDate": "2023-06-04T03:56:24.3968346-07:00", "SourceSystemId": "sample string 3", "CompanyId": "565161b9-d71d-4914-a851-72e06f7ca3ce", "CreateDate": "2023-06-04T03:56:24.3968346-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-06-04T03:56:24.3968346-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "3f8417d1-11ff-4464-a7af-b1fb5f85e36f", "EffectiveDate": "2023-06-04T03:56:24.3968346-07:00", "StateType": { "StateTypeId": "96618bc3-376a-4cb7-9ab6-f38674a5ccb9", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "1dbfd156-4048-4549-9ab8-3ba427ad7840", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "74d4f566-d512-4296-ad0e-95e0ac7762ec", "CreateDate": "2023-06-04T03:56:24.3968346-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2023-06-04T03:56:24.3968346-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "af2d2526-8138-416e-9900-d06df140fcda", "CreateDate": "2023-06-04T03:56:24.3968346-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-06-04T03:56:24.3968346-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "2291d70a-e504-44e5-9153-a207f204ab47", "CreateDate": "2023-06-04T03:56:24.3968346-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2023-06-04T03:56:24.3968346-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "8d830880-ff51-4979-b0f8-c6a35f642c97", "EffectiveDate": "2023-06-04T03:56:24.3968346-07:00", "StatusType": { "StatusTypeId": "8e994972-c83f-49d3-a045-7b9a9dd8667c", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "1dbfd156-4048-4549-9ab8-3ba427ad7840", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "74d4f566-d512-4296-ad0e-95e0ac7762ec", "CreateDate": "2023-06-04T03:56:24.3968346-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2023-06-04T03:56:24.3968346-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "ec701f4e-722c-4de4-b0bd-d563758446b0", "CreateDate": "2023-06-04T03:56:24.3968346-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2023-06-04T03:56:24.3968346-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "ae01bd58-e080-4fcb-9ed3-5266db634ecf", "CreateDate": "2023-06-04T03:56:24.3968346-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2023-06-04T03:56:24.3968346-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "b37fefa5-2d77-4be5-a279-a2858ba94f28", "EffectiveDate": "2023-06-04T03:56:24.3968346-07:00", "WellPurposeType": { "WellPurposeTypeId": "6320375b-7006-48a9-a2b3-483947fe8266", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "6178cf32-1d4a-41f1-a2b2-6601c3dbe6c2", "CreateDate": "2023-06-04T03:56:24.3968346-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2023-06-04T03:56:24.3968346-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "4c13e226-e442-4809-92d2-fc06a6b94aca", "CreateDate": "2023-06-04T03:56:24.3968346-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2023-06-04T03:56:24.3968346-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2023-06-04T03:56:24.3968346-07:00", "MeasurementValueNeededDate": "2023-06-04T03:56:24.3968346-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "db4b048d-92bf-4eaa-a2b9-f9c692f34346", "CreateDate": "2023-06-04T03:56:24.3968346-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2023-06-04T03:56:24.3968346-07:00", "LastModifiedUser": "sample string 8" } ], "Total": 1, "Message": "sample string 1" }