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": "5d2f1ae1-486d-4081-8b75-405c7c8aa601",
"Asset": {
"AssetId": "5409a28d-c206-4290-b2b5-bed15b9d14a2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "999d3987-9189-49cd-9722-3ccdea09d1ed",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "201286a9-b302-4a09-bdc8-5cd52e013925",
"CreateDate": "2026-11-03T11:27:14.5073726-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-03T11:27:14.5073726-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "07b656db-2d8f-4b80-8015-c7421c858008",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-03T11:27:14.5073726-08:00",
"MeasurementValueNeededDate": "2026-11-03T11:27:14.5073726-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "52760236-0be5-45dd-9d22-0b16a96bd954",
"CreateDate": "2026-11-03T11:27:14.5073726-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-03T11:27:14.5073726-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-11-03T11:27:14.5073726-08:00",
"MeasurementValueNeededDate": "2026-11-03T11:27:14.5073726-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "103de6b7-9bb2-4dcf-92e6-40983619a9e3",
"CreateDate": "2026-11-03T11:27:14.5073726-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-03T11:27:14.5073726-08:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"PropertyType": {
"PropertyTypeId": "f96e4468-a7aa-4bdf-980a-be730ca2fab9",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "999d3987-9189-49cd-9722-3ccdea09d1ed",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "201286a9-b302-4a09-bdc8-5cd52e013925",
"CreateDate": "2026-11-03T11:27:14.5073726-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-03T11:27:14.5073726-08:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "6d5e3a2a-69e7-49d4-8e6f-5f339dea060c",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "8c16f77f-f230-441e-8111-6e4249052de0",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f1e596f6-b15b-4be5-aa56-b505260202f6",
"CreateDate": "2026-11-03T11:27:14.5073726-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-03T11:27:14.5073726-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": "f12e358e-8e66-4f28-950e-e72421343324",
"CreateDate": "2026-11-03T11:27:14.5073726-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-03T11:27:14.5073726-08:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "6f168b5e-f1ff-4cac-a0a3-68c206692961",
"CreateDate": "2026-11-03T11:27:14.5073726-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-03T11:27:14.5073726-08:00",
"LastModifiedUser": "sample string 7"
},
{
"PropertyId": "5d2f1ae1-486d-4081-8b75-405c7c8aa601",
"Asset": {
"AssetId": "5409a28d-c206-4290-b2b5-bed15b9d14a2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "999d3987-9189-49cd-9722-3ccdea09d1ed",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "201286a9-b302-4a09-bdc8-5cd52e013925",
"CreateDate": "2026-11-03T11:27:14.5073726-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-03T11:27:14.5073726-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "07b656db-2d8f-4b80-8015-c7421c858008",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-03T11:27:14.5073726-08:00",
"MeasurementValueNeededDate": "2026-11-03T11:27:14.5073726-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "52760236-0be5-45dd-9d22-0b16a96bd954",
"CreateDate": "2026-11-03T11:27:14.5073726-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-03T11:27:14.5073726-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-11-03T11:27:14.5073726-08:00",
"MeasurementValueNeededDate": "2026-11-03T11:27:14.5073726-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "103de6b7-9bb2-4dcf-92e6-40983619a9e3",
"CreateDate": "2026-11-03T11:27:14.5073726-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-03T11:27:14.5073726-08:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"PropertyType": {
"PropertyTypeId": "f96e4468-a7aa-4bdf-980a-be730ca2fab9",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "999d3987-9189-49cd-9722-3ccdea09d1ed",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "201286a9-b302-4a09-bdc8-5cd52e013925",
"CreateDate": "2026-11-03T11:27:14.5073726-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-03T11:27:14.5073726-08:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "6d5e3a2a-69e7-49d4-8e6f-5f339dea060c",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "8c16f77f-f230-441e-8111-6e4249052de0",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f1e596f6-b15b-4be5-aa56-b505260202f6",
"CreateDate": "2026-11-03T11:27:14.5073726-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-03T11:27:14.5073726-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": "f12e358e-8e66-4f28-950e-e72421343324",
"CreateDate": "2026-11-03T11:27:14.5073726-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-03T11:27:14.5073726-08:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "6f168b5e-f1ff-4cac-a0a3-68c206692961",
"CreateDate": "2026-11-03T11:27:14.5073726-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-03T11:27:14.5073726-08:00",
"LastModifiedUser": "sample string 7"
}
],
"Total": 1,
"Message": "sample string 1"
}