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": "345cade0-e5ed-45f1-9d93-36eb870379f3",
"Asset": {
"AssetId": "e076adbd-d528-4716-954f-a5cdbd6448e0",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "989cfbba-1403-4e34-bbcc-f36e3ac6c7cb",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0397be3a-69cb-4505-8716-b5efabe7eb22",
"CreateDate": "2026-01-02T18:57:14.6346022-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-02T18:57:14.6346022-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "9f9815a2-89ad-46bf-9c10-123553452667",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-02T18:57:14.6346022-08:00",
"MeasurementValueNeededDate": "2026-01-02T18:57:14.6346022-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a15c5223-1196-4ee0-b69d-35be1da54567",
"CreateDate": "2026-01-02T18:57:14.6346022-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-02T18:57:14.6346022-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-01-02T18:57:14.6346022-08:00",
"MeasurementValueNeededDate": "2026-01-02T18:57:14.6346022-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "cb4e71dd-9596-40d1-b352-355fa3833f3b",
"CreateDate": "2026-01-02T18:57:14.6346022-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-02T18:57:14.6346022-08:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"PropertyType": {
"PropertyTypeId": "b3829f20-4a22-4d95-9ab3-bf55d607a4db",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "989cfbba-1403-4e34-bbcc-f36e3ac6c7cb",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0397be3a-69cb-4505-8716-b5efabe7eb22",
"CreateDate": "2026-01-02T18:57:14.6346022-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-02T18:57:14.6346022-08:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "841edc96-8b8a-4b07-844a-aabb2694d07d",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ce8fb701-c5ea-4184-8642-1b2bf589e0fc",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "05d781a0-a677-4d7a-ba05-5481c000fdcc",
"CreateDate": "2026-01-02T18:57:14.6346022-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-02T18:57:14.6346022-08: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": "5f6d1cfa-35f5-497f-b83b-231bbcb28064",
"CreateDate": "2026-01-02T18:57:14.6346022-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-02T18:57:14.6346022-08:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7d8e9c91-0634-4dfa-89e1-aa175356f944",
"CreateDate": "2026-01-02T18:57:14.6346022-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-02T18:57:14.6346022-08:00",
"LastModifiedUser": "sample string 7"
},
{
"PropertyId": "345cade0-e5ed-45f1-9d93-36eb870379f3",
"Asset": {
"AssetId": "e076adbd-d528-4716-954f-a5cdbd6448e0",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "989cfbba-1403-4e34-bbcc-f36e3ac6c7cb",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0397be3a-69cb-4505-8716-b5efabe7eb22",
"CreateDate": "2026-01-02T18:57:14.6346022-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-02T18:57:14.6346022-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "9f9815a2-89ad-46bf-9c10-123553452667",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-02T18:57:14.6346022-08:00",
"MeasurementValueNeededDate": "2026-01-02T18:57:14.6346022-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a15c5223-1196-4ee0-b69d-35be1da54567",
"CreateDate": "2026-01-02T18:57:14.6346022-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-02T18:57:14.6346022-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-01-02T18:57:14.6346022-08:00",
"MeasurementValueNeededDate": "2026-01-02T18:57:14.6346022-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "cb4e71dd-9596-40d1-b352-355fa3833f3b",
"CreateDate": "2026-01-02T18:57:14.6346022-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-02T18:57:14.6346022-08:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"PropertyType": {
"PropertyTypeId": "b3829f20-4a22-4d95-9ab3-bf55d607a4db",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "989cfbba-1403-4e34-bbcc-f36e3ac6c7cb",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0397be3a-69cb-4505-8716-b5efabe7eb22",
"CreateDate": "2026-01-02T18:57:14.6346022-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-02T18:57:14.6346022-08:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "841edc96-8b8a-4b07-844a-aabb2694d07d",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ce8fb701-c5ea-4184-8642-1b2bf589e0fc",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "05d781a0-a677-4d7a-ba05-5481c000fdcc",
"CreateDate": "2026-01-02T18:57:14.6346022-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-02T18:57:14.6346022-08: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": "5f6d1cfa-35f5-497f-b83b-231bbcb28064",
"CreateDate": "2026-01-02T18:57:14.6346022-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-02T18:57:14.6346022-08:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7d8e9c91-0634-4dfa-89e1-aa175356f944",
"CreateDate": "2026-01-02T18:57:14.6346022-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-02T18:57:14.6346022-08:00",
"LastModifiedUser": "sample string 7"
}
],
"Total": 1,
"Message": "sample string 1"
}