GET Properties?assetId={assetId}&propertyTypeId={propertyTypeId}&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 properties for the given parameters. This will only retrieve properties that have a value. All parameters are optional.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
assetId |
Id of the asset |
globally unique identifier |
None. |
propertyTypeId |
Id of the property type |
globally unique identifier |
None. |
take |
Number of properties to retrieve. Default is all properties |
integer |
None. |
skip |
Number of properties to skip before retrieval |
integer |
Default value is 0 |
sort |
List of sorting rules to describe how to sort the properties 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 properties.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Collection of Property |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "PropertyId": "cdf61107-e684-4253-9b5f-5ef38f28dd05", "Asset": { "AssetId": "ad3df3f6-4fd3-41cd-9f46-725992d96cf3", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "e647ada5-bfda-4d1a-8512-35bc0a0039ce", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "787605f1-d11b-4583-86bb-d5824835a6cf", "CreateDate": "2025-07-02T19:10:16.6076791-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-02T19:10:16.6076791-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "b770b766-a0bb-41f8-a29c-640f5ccd9f12", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-02T19:10:16.6076791-07:00", "MeasurementValueNeededDate": "2025-07-02T19:10:16.6076791-07:00", "SourceSystemId": "sample string 3", "CompanyId": "02f4bf87-4d08-44f1-9a00-5a9f92eb124d", "CreateDate": "2025-07-02T19:10:16.6076791-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-02T19:10:16.6076791-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-07-02T19:10:16.6076791-07:00", "MeasurementValueNeededDate": "2025-07-02T19:10:16.6076791-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "53c02621-f9e5-43eb-b946-3b2d501c93bd", "CreateDate": "2025-07-02T19:10:16.6076791-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-02T19:10:16.6076791-07:00", "LastModifiedUser": "sample string 8" }, "ValueText": "sample string 1", "PropertyType": { "PropertyTypeId": "9218c9cf-45c9-4dff-98f3-dc9276942911", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "e647ada5-bfda-4d1a-8512-35bc0a0039ce", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "787605f1-d11b-4583-86bb-d5824835a6cf", "CreateDate": "2025-07-02T19:10:16.6076791-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-02T19:10:16.6076791-07:00", "LastModifiedUser": "sample string 7" }, "DataType": { "DataTypeId": "76f39175-4848-4bab-ae3b-73b5fa9bfdd5", "Name": "sample string 1" }, "Unit": { "UnitId": "d9f4b0c8-4fd6-46e8-a3b1-fa9b9ab7edbc", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "a01a3077-a7c5-4231-b923-0d29f0ec71de", "CreateDate": "2025-07-02T19:10:16.6076791-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-02T19:10:16.6076791-07:00", "LastModifiedUser": "sample string 6" }, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "SourceSystemId": "sample string 4", "CompanyId": "2749312b-4d76-45a7-ac07-cc00e4047cf6", "CreateDate": "2025-07-02T19:10:16.6076791-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-02T19:10:16.6076791-07:00", "LastModifiedUser": "sample string 7" }, "IsValid": true, "IsValidMessage": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "21640d42-5718-4a5e-82d6-0df2f95f5c9a", "CreateDate": "2025-07-02T19:10:16.6076791-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-02T19:10:16.6076791-07:00", "LastModifiedUser": "sample string 7" }, { "PropertyId": "cdf61107-e684-4253-9b5f-5ef38f28dd05", "Asset": { "AssetId": "ad3df3f6-4fd3-41cd-9f46-725992d96cf3", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "e647ada5-bfda-4d1a-8512-35bc0a0039ce", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "787605f1-d11b-4583-86bb-d5824835a6cf", "CreateDate": "2025-07-02T19:10:16.6076791-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-02T19:10:16.6076791-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "b770b766-a0bb-41f8-a29c-640f5ccd9f12", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-02T19:10:16.6076791-07:00", "MeasurementValueNeededDate": "2025-07-02T19:10:16.6076791-07:00", "SourceSystemId": "sample string 3", "CompanyId": "02f4bf87-4d08-44f1-9a00-5a9f92eb124d", "CreateDate": "2025-07-02T19:10:16.6076791-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-02T19:10:16.6076791-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-07-02T19:10:16.6076791-07:00", "MeasurementValueNeededDate": "2025-07-02T19:10:16.6076791-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "53c02621-f9e5-43eb-b946-3b2d501c93bd", "CreateDate": "2025-07-02T19:10:16.6076791-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-02T19:10:16.6076791-07:00", "LastModifiedUser": "sample string 8" }, "ValueText": "sample string 1", "PropertyType": { "PropertyTypeId": "9218c9cf-45c9-4dff-98f3-dc9276942911", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "e647ada5-bfda-4d1a-8512-35bc0a0039ce", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "787605f1-d11b-4583-86bb-d5824835a6cf", "CreateDate": "2025-07-02T19:10:16.6076791-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-02T19:10:16.6076791-07:00", "LastModifiedUser": "sample string 7" }, "DataType": { "DataTypeId": "76f39175-4848-4bab-ae3b-73b5fa9bfdd5", "Name": "sample string 1" }, "Unit": { "UnitId": "d9f4b0c8-4fd6-46e8-a3b1-fa9b9ab7edbc", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "a01a3077-a7c5-4231-b923-0d29f0ec71de", "CreateDate": "2025-07-02T19:10:16.6076791-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-02T19:10:16.6076791-07:00", "LastModifiedUser": "sample string 6" }, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "SourceSystemId": "sample string 4", "CompanyId": "2749312b-4d76-45a7-ac07-cc00e4047cf6", "CreateDate": "2025-07-02T19:10:16.6076791-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-02T19:10:16.6076791-07:00", "LastModifiedUser": "sample string 7" }, "IsValid": true, "IsValidMessage": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "21640d42-5718-4a5e-82d6-0df2f95f5c9a", "CreateDate": "2025-07-02T19:10:16.6076791-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-02T19:10:16.6076791-07:00", "LastModifiedUser": "sample string 7" } ], "Total": 1, "Message": "sample string 1" }