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": "cce60af7-c635-41bf-aa29-e9b52b74fa44",
"Asset": {
"AssetId": "bffa168a-01eb-4a2b-a67b-77c4e4560aa2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "14dea05a-fa51-4379-bacf-28d94b8ae098",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a682ec92-f3cb-4b37-a3fb-468041626f94",
"CreateDate": "2026-06-30T00:32:49.4617673-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-30T00:32:49.4617673-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "c945eb6f-e024-4fe0-9633-e731d46d22ab",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-30T00:32:49.4617673-07:00",
"MeasurementValueNeededDate": "2026-06-30T00:32:49.4617673-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f71f7ae3-c977-4f5f-ad11-d4efe65a1066",
"CreateDate": "2026-06-30T00:32:49.4617673-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-30T00:32:49.4617673-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-06-30T00:32:49.4617673-07:00",
"MeasurementValueNeededDate": "2026-06-30T00:32:49.4617673-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "0af9f059-f3ef-48bc-89bc-87b5b0972dd6",
"CreateDate": "2026-06-30T00:32:49.4617673-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-30T00:32:49.4617673-07:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"PropertyType": {
"PropertyTypeId": "1e775d36-929e-44ee-a106-4a3ffced8b1c",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "14dea05a-fa51-4379-bacf-28d94b8ae098",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a682ec92-f3cb-4b37-a3fb-468041626f94",
"CreateDate": "2026-06-30T00:32:49.4617673-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-30T00:32:49.4617673-07:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "7c5e2ac1-495d-49e3-b7bd-cac4f9113faa",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "5bb34531-e6c0-4795-a8dd-a68cf14149a6",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9fd6f8f2-fa54-4cff-a445-5b266bf322a9",
"CreateDate": "2026-06-30T00:32:49.4617673-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-30T00:32:49.4617673-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": "134fadfe-a20a-4fa3-900a-cff5d2edb0e8",
"CreateDate": "2026-06-30T00:32:49.4617673-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-30T00:32:49.4617673-07:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "501e555e-fe3d-49ba-a712-121f85ebb5dc",
"CreateDate": "2026-06-30T00:32:49.4617673-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-30T00:32:49.4617673-07:00",
"LastModifiedUser": "sample string 7"
},
{
"PropertyId": "cce60af7-c635-41bf-aa29-e9b52b74fa44",
"Asset": {
"AssetId": "bffa168a-01eb-4a2b-a67b-77c4e4560aa2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "14dea05a-fa51-4379-bacf-28d94b8ae098",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a682ec92-f3cb-4b37-a3fb-468041626f94",
"CreateDate": "2026-06-30T00:32:49.4617673-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-30T00:32:49.4617673-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "c945eb6f-e024-4fe0-9633-e731d46d22ab",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-30T00:32:49.4617673-07:00",
"MeasurementValueNeededDate": "2026-06-30T00:32:49.4617673-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f71f7ae3-c977-4f5f-ad11-d4efe65a1066",
"CreateDate": "2026-06-30T00:32:49.4617673-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-30T00:32:49.4617673-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-06-30T00:32:49.4617673-07:00",
"MeasurementValueNeededDate": "2026-06-30T00:32:49.4617673-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "0af9f059-f3ef-48bc-89bc-87b5b0972dd6",
"CreateDate": "2026-06-30T00:32:49.4617673-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-30T00:32:49.4617673-07:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"PropertyType": {
"PropertyTypeId": "1e775d36-929e-44ee-a106-4a3ffced8b1c",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "14dea05a-fa51-4379-bacf-28d94b8ae098",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a682ec92-f3cb-4b37-a3fb-468041626f94",
"CreateDate": "2026-06-30T00:32:49.4617673-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-30T00:32:49.4617673-07:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "7c5e2ac1-495d-49e3-b7bd-cac4f9113faa",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "5bb34531-e6c0-4795-a8dd-a68cf14149a6",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9fd6f8f2-fa54-4cff-a445-5b266bf322a9",
"CreateDate": "2026-06-30T00:32:49.4617673-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-30T00:32:49.4617673-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": "134fadfe-a20a-4fa3-900a-cff5d2edb0e8",
"CreateDate": "2026-06-30T00:32:49.4617673-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-30T00:32:49.4617673-07:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "501e555e-fe3d-49ba-a712-121f85ebb5dc",
"CreateDate": "2026-06-30T00:32:49.4617673-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-30T00:32:49.4617673-07:00",
"LastModifiedUser": "sample string 7"
}
],
"Total": 1,
"Message": "sample string 1"
}