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": "5662d084-2c71-403d-aa6b-6478bc6571da", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "60138032-4e1e-48da-971c-3d30353f1e70", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "dc428657-954e-41ab-8feb-4bf77354dd63", "CreateDate": "2024-12-08T08:05:38.0945665-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-12-08T08:05:38.0945665-08:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "fcb41eb5-d5b8-4aad-bb72-8599ca05902d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-08T08:05:38.0945665-08:00", "MeasurementValueNeededDate": "2024-12-08T08:05:38.0945665-08:00", "SourceSystemId": "sample string 3", "CompanyId": "f7736678-99f3-4d9b-a99b-8ffa8a8e5aeb", "CreateDate": "2024-12-08T08:05:38.0945665-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-08T08:05:38.0945665-08:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-12-08T08:05:38.0945665-08:00", "MeasurementValueNeededDate": "2024-12-08T08:05:38.0945665-08:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "356b97c7-52ee-4683-aea5-73fda0be4f39", "CreateDate": "2024-12-08T08:05:38.0945665-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-12-08T08:05:38.0945665-08:00", "LastModifiedUser": "sample string 8" }, { "AssetId": "5662d084-2c71-403d-aa6b-6478bc6571da", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "60138032-4e1e-48da-971c-3d30353f1e70", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "dc428657-954e-41ab-8feb-4bf77354dd63", "CreateDate": "2024-12-08T08:05:38.0945665-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-12-08T08:05:38.0945665-08:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "fcb41eb5-d5b8-4aad-bb72-8599ca05902d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-08T08:05:38.0945665-08:00", "MeasurementValueNeededDate": "2024-12-08T08:05:38.0945665-08:00", "SourceSystemId": "sample string 3", "CompanyId": "f7736678-99f3-4d9b-a99b-8ffa8a8e5aeb", "CreateDate": "2024-12-08T08:05:38.0945665-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-08T08:05:38.0945665-08:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-12-08T08:05:38.0945665-08:00", "MeasurementValueNeededDate": "2024-12-08T08:05:38.0945665-08:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "356b97c7-52ee-4683-aea5-73fda0be4f39", "CreateDate": "2024-12-08T08:05:38.0945665-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-12-08T08:05:38.0945665-08:00", "LastModifiedUser": "sample string 8" } ], "Total": 1, "Message": "sample string 1" }