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": "354a0988-4c9c-46f7-92ff-f99f962a9d00",
"Asset": {
"AssetId": "62732fc9-05ac-4b07-a7a8-9efb17888904",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "6a80ca6c-8428-4d90-9dc5-cdf4a8af0d23",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "517b7ea3-6502-4e55-b39d-549fb3fcb072",
"CreateDate": "2026-07-14T00:14:51.6350992-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-14T00:14:51.6350992-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "4e65c4d1-b9fe-4fc0-b25b-b48d122c78d7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-14T00:14:51.6350992-07:00",
"MeasurementValueNeededDate": "2026-07-14T00:14:51.6350992-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "31cfe7a9-2e2e-42fa-80aa-8b04965ea703",
"CreateDate": "2026-07-14T00:14:51.6350992-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-14T00:14:51.6350992-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-07-14T00:14:51.6350992-07:00",
"MeasurementValueNeededDate": "2026-07-14T00:14:51.6350992-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "31473585-7aa1-4f42-8aa9-2276b405ca61",
"CreateDate": "2026-07-14T00:14:51.6350992-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-14T00:14:51.6350992-07:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"PropertyType": {
"PropertyTypeId": "6982b018-1cec-49c9-8206-177756b5fabe",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "6a80ca6c-8428-4d90-9dc5-cdf4a8af0d23",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "517b7ea3-6502-4e55-b39d-549fb3fcb072",
"CreateDate": "2026-07-14T00:14:51.6350992-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-14T00:14:51.6350992-07:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "523d9591-867f-42e7-9de8-cc68039e77df",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "a5ecf5b6-1137-41bc-b31e-08780954c95e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5b81f8ac-b1c6-440d-929f-2b7a5d3ed02d",
"CreateDate": "2026-07-14T00:14:51.6350992-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-14T00:14:51.6350992-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": "b6af5de8-35a6-4acc-92b8-c48aa9371c69",
"CreateDate": "2026-07-14T00:14:51.6350992-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-14T00:14:51.6350992-07:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "02ac8f63-a3a1-421c-aedd-52c9ac70cab8",
"CreateDate": "2026-07-14T00:14:51.6350992-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-14T00:14:51.6350992-07:00",
"LastModifiedUser": "sample string 7"
},
{
"PropertyId": "354a0988-4c9c-46f7-92ff-f99f962a9d00",
"Asset": {
"AssetId": "62732fc9-05ac-4b07-a7a8-9efb17888904",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "6a80ca6c-8428-4d90-9dc5-cdf4a8af0d23",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "517b7ea3-6502-4e55-b39d-549fb3fcb072",
"CreateDate": "2026-07-14T00:14:51.6350992-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-14T00:14:51.6350992-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "4e65c4d1-b9fe-4fc0-b25b-b48d122c78d7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-14T00:14:51.6350992-07:00",
"MeasurementValueNeededDate": "2026-07-14T00:14:51.6350992-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "31cfe7a9-2e2e-42fa-80aa-8b04965ea703",
"CreateDate": "2026-07-14T00:14:51.6350992-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-14T00:14:51.6350992-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-07-14T00:14:51.6350992-07:00",
"MeasurementValueNeededDate": "2026-07-14T00:14:51.6350992-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "31473585-7aa1-4f42-8aa9-2276b405ca61",
"CreateDate": "2026-07-14T00:14:51.6350992-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-14T00:14:51.6350992-07:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"PropertyType": {
"PropertyTypeId": "6982b018-1cec-49c9-8206-177756b5fabe",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "6a80ca6c-8428-4d90-9dc5-cdf4a8af0d23",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "517b7ea3-6502-4e55-b39d-549fb3fcb072",
"CreateDate": "2026-07-14T00:14:51.6350992-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-14T00:14:51.6350992-07:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "523d9591-867f-42e7-9de8-cc68039e77df",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "a5ecf5b6-1137-41bc-b31e-08780954c95e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5b81f8ac-b1c6-440d-929f-2b7a5d3ed02d",
"CreateDate": "2026-07-14T00:14:51.6350992-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-14T00:14:51.6350992-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": "b6af5de8-35a6-4acc-92b8-c48aa9371c69",
"CreateDate": "2026-07-14T00:14:51.6350992-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-14T00:14:51.6350992-07:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "02ac8f63-a3a1-421c-aedd-52c9ac70cab8",
"CreateDate": "2026-07-14T00:14:51.6350992-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-14T00:14:51.6350992-07:00",
"LastModifiedUser": "sample string 7"
}
],
"Total": 1,
"Message": "sample string 1"
}