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": "1dc32fba-1c72-4d38-8491-fbb0e7f493f2",
"Asset": {
"AssetId": "c8475652-5553-423a-b6ec-00ebbf34e8fb",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "0c8c62df-6722-4149-8314-6c15a18e588b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a2728c50-158b-48ca-b2c8-ff3838b74105",
"CreateDate": "2025-11-02T22:32:36.2996056-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-02T22:32:36.2996056-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "3446d72f-51e1-4414-98c7-493cc7b33a54",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-02T22:32:36.2996056-08:00",
"MeasurementValueNeededDate": "2025-11-02T22:32:36.2996056-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "21217361-7a45-4ac6-805e-06e988281618",
"CreateDate": "2025-11-02T22:32:36.2996056-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-02T22:32:36.2996056-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-11-02T22:32:36.2996056-08:00",
"MeasurementValueNeededDate": "2025-11-02T22:32:36.2996056-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "523eedc0-f473-436c-918c-a14368f57a0e",
"CreateDate": "2025-11-02T22:32:36.2996056-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-02T22:32:36.2996056-08:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"PropertyType": {
"PropertyTypeId": "efab5b56-a260-4292-921f-dab25d051995",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "0c8c62df-6722-4149-8314-6c15a18e588b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a2728c50-158b-48ca-b2c8-ff3838b74105",
"CreateDate": "2025-11-02T22:32:36.2996056-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-02T22:32:36.2996056-08:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "36538676-0e1b-4cb8-86c5-59647dc90138",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "a7458c77-18a3-41d5-95b6-fdf8ff3ee860",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "67b11740-1723-41d7-9f9c-cb485ac4b15d",
"CreateDate": "2025-11-02T22:32:36.2996056-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-02T22:32:36.2996056-08: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": "5bc47ec2-0154-45ad-a414-fd59e87753c0",
"CreateDate": "2025-11-02T22:32:36.2996056-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-02T22:32:36.2996056-08:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ed7eb2de-f67c-4248-a114-9d0dbd8eda57",
"CreateDate": "2025-11-02T22:32:36.2996056-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-02T22:32:36.2996056-08:00",
"LastModifiedUser": "sample string 7"
},
{
"PropertyId": "1dc32fba-1c72-4d38-8491-fbb0e7f493f2",
"Asset": {
"AssetId": "c8475652-5553-423a-b6ec-00ebbf34e8fb",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "0c8c62df-6722-4149-8314-6c15a18e588b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a2728c50-158b-48ca-b2c8-ff3838b74105",
"CreateDate": "2025-11-02T22:32:36.2996056-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-02T22:32:36.2996056-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "3446d72f-51e1-4414-98c7-493cc7b33a54",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-02T22:32:36.2996056-08:00",
"MeasurementValueNeededDate": "2025-11-02T22:32:36.2996056-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "21217361-7a45-4ac6-805e-06e988281618",
"CreateDate": "2025-11-02T22:32:36.2996056-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-02T22:32:36.2996056-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-11-02T22:32:36.2996056-08:00",
"MeasurementValueNeededDate": "2025-11-02T22:32:36.2996056-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "523eedc0-f473-436c-918c-a14368f57a0e",
"CreateDate": "2025-11-02T22:32:36.2996056-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-02T22:32:36.2996056-08:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"PropertyType": {
"PropertyTypeId": "efab5b56-a260-4292-921f-dab25d051995",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "0c8c62df-6722-4149-8314-6c15a18e588b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a2728c50-158b-48ca-b2c8-ff3838b74105",
"CreateDate": "2025-11-02T22:32:36.2996056-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-02T22:32:36.2996056-08:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "36538676-0e1b-4cb8-86c5-59647dc90138",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "a7458c77-18a3-41d5-95b6-fdf8ff3ee860",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "67b11740-1723-41d7-9f9c-cb485ac4b15d",
"CreateDate": "2025-11-02T22:32:36.2996056-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-02T22:32:36.2996056-08: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": "5bc47ec2-0154-45ad-a414-fd59e87753c0",
"CreateDate": "2025-11-02T22:32:36.2996056-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-02T22:32:36.2996056-08:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ed7eb2de-f67c-4248-a114-9d0dbd8eda57",
"CreateDate": "2025-11-02T22:32:36.2996056-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-02T22:32:36.2996056-08:00",
"LastModifiedUser": "sample string 7"
}
],
"Total": 1,
"Message": "sample string 1"
}