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": "06db29e2-2e20-40a2-a7a3-3b7481b4e6f7",
"Asset": {
"AssetId": "7b3c1a84-ed70-45de-a8e6-a96303fe4fc3",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2ed6e948-a085-44a8-b3fc-a41deb5d5fa5",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9b48adab-434a-4327-82c9-0567642dd485",
"CreateDate": "2026-10-20T12:07:18.7006299-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-20T12:07:18.7006299-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "8a4dbfef-ff3e-456c-a01c-f4f0611c6b3d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-20T12:07:18.7006299-07:00",
"MeasurementValueNeededDate": "2026-10-20T12:07:18.7006299-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "d840785f-3dcd-4b01-bc5d-3f3f09b96b5d",
"CreateDate": "2026-10-20T12:07:18.7006299-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-20T12:07:18.7006299-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-10-20T12:07:18.7006299-07:00",
"MeasurementValueNeededDate": "2026-10-20T12:07:18.7006299-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "dc511056-5073-4775-a103-5b03229f1954",
"CreateDate": "2026-10-20T12:07:18.7006299-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-20T12:07:18.7006299-07:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"PropertyType": {
"PropertyTypeId": "aabbffad-88bf-4b18-a511-0526f56a0704",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "2ed6e948-a085-44a8-b3fc-a41deb5d5fa5",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9b48adab-434a-4327-82c9-0567642dd485",
"CreateDate": "2026-10-20T12:07:18.7006299-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-20T12:07:18.7006299-07:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "9071976e-1a5c-486f-9d09-2b76ecad7252",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d6c0cdd0-df2d-4286-baeb-b8e3c8bafb02",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "7471bb3b-5ca3-40bf-8c07-242e71ff49c6",
"CreateDate": "2026-10-20T12:07:18.7006299-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-20T12:07:18.7006299-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": "0dbb70d1-82a9-41a5-abc1-71f4cf5c088f",
"CreateDate": "2026-10-20T12:07:18.7006299-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-20T12:07:18.7006299-07:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4206cd6c-2516-46d5-8b07-28f5413f2aab",
"CreateDate": "2026-10-20T12:07:18.7006299-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-20T12:07:18.7006299-07:00",
"LastModifiedUser": "sample string 7"
},
{
"PropertyId": "06db29e2-2e20-40a2-a7a3-3b7481b4e6f7",
"Asset": {
"AssetId": "7b3c1a84-ed70-45de-a8e6-a96303fe4fc3",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2ed6e948-a085-44a8-b3fc-a41deb5d5fa5",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9b48adab-434a-4327-82c9-0567642dd485",
"CreateDate": "2026-10-20T12:07:18.7006299-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-20T12:07:18.7006299-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "8a4dbfef-ff3e-456c-a01c-f4f0611c6b3d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-20T12:07:18.7006299-07:00",
"MeasurementValueNeededDate": "2026-10-20T12:07:18.7006299-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "d840785f-3dcd-4b01-bc5d-3f3f09b96b5d",
"CreateDate": "2026-10-20T12:07:18.7006299-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-20T12:07:18.7006299-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-10-20T12:07:18.7006299-07:00",
"MeasurementValueNeededDate": "2026-10-20T12:07:18.7006299-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "dc511056-5073-4775-a103-5b03229f1954",
"CreateDate": "2026-10-20T12:07:18.7006299-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-20T12:07:18.7006299-07:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"PropertyType": {
"PropertyTypeId": "aabbffad-88bf-4b18-a511-0526f56a0704",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "2ed6e948-a085-44a8-b3fc-a41deb5d5fa5",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9b48adab-434a-4327-82c9-0567642dd485",
"CreateDate": "2026-10-20T12:07:18.7006299-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-20T12:07:18.7006299-07:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "9071976e-1a5c-486f-9d09-2b76ecad7252",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d6c0cdd0-df2d-4286-baeb-b8e3c8bafb02",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "7471bb3b-5ca3-40bf-8c07-242e71ff49c6",
"CreateDate": "2026-10-20T12:07:18.7006299-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-20T12:07:18.7006299-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": "0dbb70d1-82a9-41a5-abc1-71f4cf5c088f",
"CreateDate": "2026-10-20T12:07:18.7006299-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-20T12:07:18.7006299-07:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4206cd6c-2516-46d5-8b07-28f5413f2aab",
"CreateDate": "2026-10-20T12:07:18.7006299-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-20T12:07:18.7006299-07:00",
"LastModifiedUser": "sample string 7"
}
],
"Total": 1,
"Message": "sample string 1"
}