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": "3fd60021-7c23-4b80-b2ca-e5ef8b0ed068",
"Asset": {
"AssetId": "97098ccc-4d9b-4365-ba9d-3657456287e2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "35ab6cfd-b9c6-422d-b692-679fe233e0c0",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "082f5696-6dc7-45c1-ac24-59e9a21501ab",
"CreateDate": "2026-07-28T00:47:08.6399379-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-28T00:47:08.6399379-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "1a769dca-1f63-4e5e-8c6a-9b893fcf4e3c",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-28T00:47:08.6399379-07:00",
"MeasurementValueNeededDate": "2026-07-28T00:47:08.6399379-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "fe58dbcf-f680-4cc7-a9d3-f9fa0c61d2ee",
"CreateDate": "2026-07-28T00:47:08.6399379-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-28T00:47:08.6399379-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-07-28T00:47:08.6399379-07:00",
"MeasurementValueNeededDate": "2026-07-28T00:47:08.6399379-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "ff8e3f66-8dd4-40fa-96e3-b4bdc4e19f63",
"CreateDate": "2026-07-28T00:47:08.6399379-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-28T00:47:08.6399379-07:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"PropertyType": {
"PropertyTypeId": "8454424a-bfeb-4146-99c7-73bf50ae7060",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "35ab6cfd-b9c6-422d-b692-679fe233e0c0",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "082f5696-6dc7-45c1-ac24-59e9a21501ab",
"CreateDate": "2026-07-28T00:47:08.6399379-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-28T00:47:08.6399379-07:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "3e2b2815-9c7f-4f16-866e-25e2c16d4495",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "7b9abcd5-7108-4a8a-8e6f-b4b07c224d4f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6551f909-a3f5-4eaf-b417-5fc1a9e7b1a2",
"CreateDate": "2026-07-28T00:47:08.6399379-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-28T00:47:08.6399379-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": "c69090ec-6fda-4bf2-b242-26f5799f5a51",
"CreateDate": "2026-07-28T00:47:08.6399379-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-28T00:47:08.6399379-07:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9aed5be5-defa-4b78-a721-a9906fb621a2",
"CreateDate": "2026-07-28T00:47:08.6399379-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-28T00:47:08.6399379-07:00",
"LastModifiedUser": "sample string 7"
},
{
"PropertyId": "3fd60021-7c23-4b80-b2ca-e5ef8b0ed068",
"Asset": {
"AssetId": "97098ccc-4d9b-4365-ba9d-3657456287e2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "35ab6cfd-b9c6-422d-b692-679fe233e0c0",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "082f5696-6dc7-45c1-ac24-59e9a21501ab",
"CreateDate": "2026-07-28T00:47:08.6399379-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-28T00:47:08.6399379-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "1a769dca-1f63-4e5e-8c6a-9b893fcf4e3c",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-28T00:47:08.6399379-07:00",
"MeasurementValueNeededDate": "2026-07-28T00:47:08.6399379-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "fe58dbcf-f680-4cc7-a9d3-f9fa0c61d2ee",
"CreateDate": "2026-07-28T00:47:08.6399379-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-28T00:47:08.6399379-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-07-28T00:47:08.6399379-07:00",
"MeasurementValueNeededDate": "2026-07-28T00:47:08.6399379-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "ff8e3f66-8dd4-40fa-96e3-b4bdc4e19f63",
"CreateDate": "2026-07-28T00:47:08.6399379-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-28T00:47:08.6399379-07:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"PropertyType": {
"PropertyTypeId": "8454424a-bfeb-4146-99c7-73bf50ae7060",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "35ab6cfd-b9c6-422d-b692-679fe233e0c0",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "082f5696-6dc7-45c1-ac24-59e9a21501ab",
"CreateDate": "2026-07-28T00:47:08.6399379-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-28T00:47:08.6399379-07:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "3e2b2815-9c7f-4f16-866e-25e2c16d4495",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "7b9abcd5-7108-4a8a-8e6f-b4b07c224d4f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6551f909-a3f5-4eaf-b417-5fc1a9e7b1a2",
"CreateDate": "2026-07-28T00:47:08.6399379-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-28T00:47:08.6399379-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": "c69090ec-6fda-4bf2-b242-26f5799f5a51",
"CreateDate": "2026-07-28T00:47:08.6399379-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-28T00:47:08.6399379-07:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9aed5be5-defa-4b78-a721-a9906fb621a2",
"CreateDate": "2026-07-28T00:47:08.6399379-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-28T00:47:08.6399379-07:00",
"LastModifiedUser": "sample string 7"
}
],
"Total": 1,
"Message": "sample string 1"
}