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": "a4797895-7449-472f-b12c-f9132bf53c0e",
"Asset": {
"AssetId": "f29f750c-81ef-49f3-b8c9-88c29c5c793b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "d6f81d2b-41d4-4f80-a643-9826534e3c13",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0662849e-756d-40cc-a6cb-6c68363a0de5",
"CreateDate": "2026-09-22T04:09:11.0675717-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-22T04:09:11.0675717-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "7eac6b16-1c63-4ca6-a14d-a4102e90bf3a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-22T04:09:11.0675717-07:00",
"MeasurementValueNeededDate": "2026-09-22T04:09:11.0675717-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e5cb5d0d-9efb-4ddd-b6cf-5eb07d669535",
"CreateDate": "2026-09-22T04:09:11.0675717-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-22T04:09:11.0675717-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-09-22T04:09:11.0675717-07:00",
"MeasurementValueNeededDate": "2026-09-22T04:09:11.0675717-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "efde0198-928f-459c-a44b-46b64642c16d",
"CreateDate": "2026-09-22T04:09:11.0675717-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-22T04:09:11.0675717-07:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"PropertyType": {
"PropertyTypeId": "d156aa4d-53e4-4173-affe-084f42fbe941",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "d6f81d2b-41d4-4f80-a643-9826534e3c13",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0662849e-756d-40cc-a6cb-6c68363a0de5",
"CreateDate": "2026-09-22T04:09:11.0675717-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-22T04:09:11.0675717-07:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "0956ee26-12cf-472b-8883-8f8210b7bdfb",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "9d8c8b1a-a773-48d1-b707-be0ca0fbe778",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f3ca5c07-b897-45f6-a311-d9b73ab215a6",
"CreateDate": "2026-09-22T04:09:11.0675717-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-22T04:09:11.0675717-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": "daa8a561-3561-45e7-b27a-74b9626a1a85",
"CreateDate": "2026-09-22T04:09:11.0675717-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-22T04:09:11.0675717-07:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1ea1e1d6-bc4a-41be-8451-636502409f3d",
"CreateDate": "2026-09-22T04:09:11.0675717-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-22T04:09:11.0675717-07:00",
"LastModifiedUser": "sample string 7"
},
{
"PropertyId": "a4797895-7449-472f-b12c-f9132bf53c0e",
"Asset": {
"AssetId": "f29f750c-81ef-49f3-b8c9-88c29c5c793b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "d6f81d2b-41d4-4f80-a643-9826534e3c13",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0662849e-756d-40cc-a6cb-6c68363a0de5",
"CreateDate": "2026-09-22T04:09:11.0675717-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-22T04:09:11.0675717-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "7eac6b16-1c63-4ca6-a14d-a4102e90bf3a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-22T04:09:11.0675717-07:00",
"MeasurementValueNeededDate": "2026-09-22T04:09:11.0675717-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e5cb5d0d-9efb-4ddd-b6cf-5eb07d669535",
"CreateDate": "2026-09-22T04:09:11.0675717-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-22T04:09:11.0675717-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-09-22T04:09:11.0675717-07:00",
"MeasurementValueNeededDate": "2026-09-22T04:09:11.0675717-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "efde0198-928f-459c-a44b-46b64642c16d",
"CreateDate": "2026-09-22T04:09:11.0675717-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-22T04:09:11.0675717-07:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"PropertyType": {
"PropertyTypeId": "d156aa4d-53e4-4173-affe-084f42fbe941",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "d6f81d2b-41d4-4f80-a643-9826534e3c13",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0662849e-756d-40cc-a6cb-6c68363a0de5",
"CreateDate": "2026-09-22T04:09:11.0675717-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-22T04:09:11.0675717-07:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "0956ee26-12cf-472b-8883-8f8210b7bdfb",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "9d8c8b1a-a773-48d1-b707-be0ca0fbe778",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f3ca5c07-b897-45f6-a311-d9b73ab215a6",
"CreateDate": "2026-09-22T04:09:11.0675717-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-22T04:09:11.0675717-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": "daa8a561-3561-45e7-b27a-74b9626a1a85",
"CreateDate": "2026-09-22T04:09:11.0675717-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-22T04:09:11.0675717-07:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1ea1e1d6-bc4a-41be-8451-636502409f3d",
"CreateDate": "2026-09-22T04:09:11.0675717-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-22T04:09:11.0675717-07:00",
"LastModifiedUser": "sample string 7"
}
],
"Total": 1,
"Message": "sample string 1"
}