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": "fc60c9ec-239f-4026-ac25-bb50d5c7c034",
"Asset": {
"AssetId": "e5dd8195-ec8f-4359-9aaa-e95e9a50913d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "92cc4ef6-79b5-40f4-a3d0-509763e9f4b2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b21e2210-5b18-487e-b25c-c3f271dd2fd2",
"CreateDate": "2026-10-06T11:53:21.9740006-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-06T11:53:21.9740006-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "6663aeb2-c82c-489e-9cbb-d4c213267230",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-06T11:53:21.9740006-07:00",
"MeasurementValueNeededDate": "2026-10-06T11:53:21.9740006-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a8c64d7a-b0e3-4e41-8961-e39b7e261065",
"CreateDate": "2026-10-06T11:53:21.9740006-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-06T11:53:21.9740006-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-10-06T11:53:21.9740006-07:00",
"MeasurementValueNeededDate": "2026-10-06T11:53:21.9740006-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "8a2cc514-3d24-42ed-8051-edb85b9dd998",
"CreateDate": "2026-10-06T11:53:21.9740006-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-06T11:53:21.9740006-07:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"PropertyType": {
"PropertyTypeId": "a2aa8e61-0f5d-4f42-9688-804f964c66c2",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "92cc4ef6-79b5-40f4-a3d0-509763e9f4b2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b21e2210-5b18-487e-b25c-c3f271dd2fd2",
"CreateDate": "2026-10-06T11:53:21.9740006-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-06T11:53:21.9740006-07:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "a31593f6-29dd-435a-ad77-d104b407e05d",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "063bec7e-52fa-4770-a4b4-204f14dde9c6",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1ac0fdc9-852a-4c38-a050-bc6c1614821f",
"CreateDate": "2026-10-06T11:53:21.9740006-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-06T11:53:21.9740006-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": "672b74ab-654d-4ece-9d82-a40901444f0b",
"CreateDate": "2026-10-06T11:53:21.9740006-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-06T11:53:21.9740006-07:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "bd25106c-7662-4f44-b3da-42e0e2a56a9a",
"CreateDate": "2026-10-06T11:53:21.9740006-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-06T11:53:21.9740006-07:00",
"LastModifiedUser": "sample string 7"
},
{
"PropertyId": "fc60c9ec-239f-4026-ac25-bb50d5c7c034",
"Asset": {
"AssetId": "e5dd8195-ec8f-4359-9aaa-e95e9a50913d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "92cc4ef6-79b5-40f4-a3d0-509763e9f4b2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b21e2210-5b18-487e-b25c-c3f271dd2fd2",
"CreateDate": "2026-10-06T11:53:21.9740006-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-06T11:53:21.9740006-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "6663aeb2-c82c-489e-9cbb-d4c213267230",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-06T11:53:21.9740006-07:00",
"MeasurementValueNeededDate": "2026-10-06T11:53:21.9740006-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a8c64d7a-b0e3-4e41-8961-e39b7e261065",
"CreateDate": "2026-10-06T11:53:21.9740006-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-06T11:53:21.9740006-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-10-06T11:53:21.9740006-07:00",
"MeasurementValueNeededDate": "2026-10-06T11:53:21.9740006-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "8a2cc514-3d24-42ed-8051-edb85b9dd998",
"CreateDate": "2026-10-06T11:53:21.9740006-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-06T11:53:21.9740006-07:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"PropertyType": {
"PropertyTypeId": "a2aa8e61-0f5d-4f42-9688-804f964c66c2",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "92cc4ef6-79b5-40f4-a3d0-509763e9f4b2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b21e2210-5b18-487e-b25c-c3f271dd2fd2",
"CreateDate": "2026-10-06T11:53:21.9740006-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-06T11:53:21.9740006-07:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "a31593f6-29dd-435a-ad77-d104b407e05d",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "063bec7e-52fa-4770-a4b4-204f14dde9c6",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1ac0fdc9-852a-4c38-a050-bc6c1614821f",
"CreateDate": "2026-10-06T11:53:21.9740006-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-06T11:53:21.9740006-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": "672b74ab-654d-4ece-9d82-a40901444f0b",
"CreateDate": "2026-10-06T11:53:21.9740006-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-06T11:53:21.9740006-07:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "bd25106c-7662-4f44-b3da-42e0e2a56a9a",
"CreateDate": "2026-10-06T11:53:21.9740006-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-06T11:53:21.9740006-07:00",
"LastModifiedUser": "sample string 7"
}
],
"Total": 1,
"Message": "sample string 1"
}