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": "b9035364-2c17-48f7-bb70-ddeaa5521fb9",
"Asset": {
"AssetId": "2217a4c2-de89-4cc5-88f1-197ca992d777",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "18c42b96-acad-4514-bb8e-d0e946862863",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "851488bd-0915-4052-8c61-56fc91998bba",
"CreateDate": "2026-05-02T16:03:30.4189562-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-02T16:03:30.4189562-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "c43c0ff1-55f7-4780-9cca-146d35433b8e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-02T16:03:30.4189562-07:00",
"MeasurementValueNeededDate": "2026-05-02T16:03:30.4189562-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2a99d1ec-82c6-48b7-9b75-f27b8c43ad8e",
"CreateDate": "2026-05-02T16:03:30.4189562-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-02T16:03:30.4189562-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-05-02T16:03:30.4189562-07:00",
"MeasurementValueNeededDate": "2026-05-02T16:03:30.4189562-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "f4928afa-90cc-4841-bf40-6028d040e68f",
"CreateDate": "2026-05-02T16:03:30.4189562-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-02T16:03:30.4189562-07:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"PropertyType": {
"PropertyTypeId": "ec87a3ba-53e9-4c21-8d28-2b7747450c8e",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "18c42b96-acad-4514-bb8e-d0e946862863",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "851488bd-0915-4052-8c61-56fc91998bba",
"CreateDate": "2026-05-02T16:03:30.4189562-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-02T16:03:30.4189562-07:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "e44b71db-b8aa-4dc5-b7fd-95a355f9bffd",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "46b0be8d-bf1e-413c-a1d8-2360b78fa575",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "3c208bdc-170d-40b2-8fec-4cbe7124d181",
"CreateDate": "2026-05-02T16:03:30.4189562-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-02T16:03:30.4189562-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": "be8a2a19-38fb-4e4b-bd24-56e8c7e21a5c",
"CreateDate": "2026-05-02T16:03:30.4189562-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-02T16:03:30.4189562-07:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d9a49a1e-024d-4023-9814-aabead2647b8",
"CreateDate": "2026-05-02T16:03:30.4189562-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-02T16:03:30.4189562-07:00",
"LastModifiedUser": "sample string 7"
},
{
"PropertyId": "b9035364-2c17-48f7-bb70-ddeaa5521fb9",
"Asset": {
"AssetId": "2217a4c2-de89-4cc5-88f1-197ca992d777",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "18c42b96-acad-4514-bb8e-d0e946862863",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "851488bd-0915-4052-8c61-56fc91998bba",
"CreateDate": "2026-05-02T16:03:30.4189562-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-02T16:03:30.4189562-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "c43c0ff1-55f7-4780-9cca-146d35433b8e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-02T16:03:30.4189562-07:00",
"MeasurementValueNeededDate": "2026-05-02T16:03:30.4189562-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2a99d1ec-82c6-48b7-9b75-f27b8c43ad8e",
"CreateDate": "2026-05-02T16:03:30.4189562-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-02T16:03:30.4189562-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-05-02T16:03:30.4189562-07:00",
"MeasurementValueNeededDate": "2026-05-02T16:03:30.4189562-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "f4928afa-90cc-4841-bf40-6028d040e68f",
"CreateDate": "2026-05-02T16:03:30.4189562-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-02T16:03:30.4189562-07:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"PropertyType": {
"PropertyTypeId": "ec87a3ba-53e9-4c21-8d28-2b7747450c8e",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "18c42b96-acad-4514-bb8e-d0e946862863",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "851488bd-0915-4052-8c61-56fc91998bba",
"CreateDate": "2026-05-02T16:03:30.4189562-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-02T16:03:30.4189562-07:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "e44b71db-b8aa-4dc5-b7fd-95a355f9bffd",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "46b0be8d-bf1e-413c-a1d8-2360b78fa575",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "3c208bdc-170d-40b2-8fec-4cbe7124d181",
"CreateDate": "2026-05-02T16:03:30.4189562-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-02T16:03:30.4189562-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": "be8a2a19-38fb-4e4b-bd24-56e8c7e21a5c",
"CreateDate": "2026-05-02T16:03:30.4189562-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-02T16:03:30.4189562-07:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d9a49a1e-024d-4023-9814-aabead2647b8",
"CreateDate": "2026-05-02T16:03:30.4189562-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-02T16:03:30.4189562-07:00",
"LastModifiedUser": "sample string 7"
}
],
"Total": 1,
"Message": "sample string 1"
}