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": "362125dc-890c-4f21-a3c8-d9ed52dbe921",
"Asset": {
"AssetId": "9706685c-92b9-4ede-a654-5d98076777ed",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "a28736b9-c86f-415c-a23e-71ebf1c2c066",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0e6836b5-3b42-47cd-a0ed-793a6e4cc2cd",
"CreateDate": "2026-06-01T23:29:30.3781513-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-01T23:29:30.3781513-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "be13c243-8014-4341-9db9-f2ef4cd6020a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-01T23:29:30.3781513-07:00",
"MeasurementValueNeededDate": "2026-06-01T23:29:30.3781513-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "17820805-68c0-4793-b704-3b77a256d9c4",
"CreateDate": "2026-06-01T23:29:30.3781513-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-01T23:29:30.3781513-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-06-01T23:29:30.3781513-07:00",
"MeasurementValueNeededDate": "2026-06-01T23:29:30.3781513-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "9eb6b406-3c2c-4a5d-b467-a66e093c172d",
"CreateDate": "2026-06-01T23:29:30.3781513-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-01T23:29:30.3781513-07:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"PropertyType": {
"PropertyTypeId": "9be300e8-13c0-439d-8271-0dc5b5a82a1e",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "a28736b9-c86f-415c-a23e-71ebf1c2c066",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0e6836b5-3b42-47cd-a0ed-793a6e4cc2cd",
"CreateDate": "2026-06-01T23:29:30.3781513-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-01T23:29:30.3781513-07:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "819fb315-b9f1-4b76-9ead-2e0010bfc3c4",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "a892bbeb-0708-4426-bb20-c1eed46ec68b",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "546e6c90-52ed-4d38-81d7-6562b4ba30dc",
"CreateDate": "2026-06-01T23:29:30.3781513-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-01T23:29:30.3781513-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": "ca05cffa-95c8-429d-820c-a0b729936250",
"CreateDate": "2026-06-01T23:29:30.3781513-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-01T23:29:30.3781513-07:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9d30cb71-6513-4aee-9151-1ce6336ee6d9",
"CreateDate": "2026-06-01T23:29:30.3781513-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-01T23:29:30.3781513-07:00",
"LastModifiedUser": "sample string 7"
},
{
"PropertyId": "362125dc-890c-4f21-a3c8-d9ed52dbe921",
"Asset": {
"AssetId": "9706685c-92b9-4ede-a654-5d98076777ed",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "a28736b9-c86f-415c-a23e-71ebf1c2c066",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0e6836b5-3b42-47cd-a0ed-793a6e4cc2cd",
"CreateDate": "2026-06-01T23:29:30.3781513-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-01T23:29:30.3781513-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "be13c243-8014-4341-9db9-f2ef4cd6020a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-01T23:29:30.3781513-07:00",
"MeasurementValueNeededDate": "2026-06-01T23:29:30.3781513-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "17820805-68c0-4793-b704-3b77a256d9c4",
"CreateDate": "2026-06-01T23:29:30.3781513-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-01T23:29:30.3781513-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-06-01T23:29:30.3781513-07:00",
"MeasurementValueNeededDate": "2026-06-01T23:29:30.3781513-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "9eb6b406-3c2c-4a5d-b467-a66e093c172d",
"CreateDate": "2026-06-01T23:29:30.3781513-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-01T23:29:30.3781513-07:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"PropertyType": {
"PropertyTypeId": "9be300e8-13c0-439d-8271-0dc5b5a82a1e",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "a28736b9-c86f-415c-a23e-71ebf1c2c066",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0e6836b5-3b42-47cd-a0ed-793a6e4cc2cd",
"CreateDate": "2026-06-01T23:29:30.3781513-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-01T23:29:30.3781513-07:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "819fb315-b9f1-4b76-9ead-2e0010bfc3c4",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "a892bbeb-0708-4426-bb20-c1eed46ec68b",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "546e6c90-52ed-4d38-81d7-6562b4ba30dc",
"CreateDate": "2026-06-01T23:29:30.3781513-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-01T23:29:30.3781513-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": "ca05cffa-95c8-429d-820c-a0b729936250",
"CreateDate": "2026-06-01T23:29:30.3781513-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-01T23:29:30.3781513-07:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9d30cb71-6513-4aee-9151-1ce6336ee6d9",
"CreateDate": "2026-06-01T23:29:30.3781513-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-01T23:29:30.3781513-07:00",
"LastModifiedUser": "sample string 7"
}
],
"Total": 1,
"Message": "sample string 1"
}