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": "0333a66c-c940-4ac8-bb83-a9384a4ef6a9",
"Asset": {
"AssetId": "7360b974-529d-4941-863e-f1908cad4387",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "b723b023-0345-4dce-9bde-9033ac476fd3",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "13def643-5411-4666-b319-09b56f07586d",
"CreateDate": "2026-08-11T01:18:43.9836669-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-11T01:18:43.9836669-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "1360fbc2-d8e3-490f-87d1-973f131da5e6",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-11T01:18:43.9836669-07:00",
"MeasurementValueNeededDate": "2026-08-11T01:18:43.9836669-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5f45fa73-00a4-4e13-a228-09f70aa0aa0c",
"CreateDate": "2026-08-11T01:18:43.9836669-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-11T01:18:43.9836669-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-08-11T01:18:43.9836669-07:00",
"MeasurementValueNeededDate": "2026-08-11T01:18:43.9836669-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "b24ff61f-a7b0-4920-a48d-c7045b106d62",
"CreateDate": "2026-08-11T01:18:43.9836669-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T01:18:43.9836669-07:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"PropertyType": {
"PropertyTypeId": "f269bd21-efd4-46db-8e32-1ceb6eadcc5c",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "b723b023-0345-4dce-9bde-9033ac476fd3",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "13def643-5411-4666-b319-09b56f07586d",
"CreateDate": "2026-08-11T01:18:43.9836669-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-11T01:18:43.9836669-07:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "07295099-117c-426e-830b-fa9b8f2c334a",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "32675581-28ab-4d5e-a178-1cae03de14d3",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "cb879544-5919-4aa2-bd3b-535faa642bf8",
"CreateDate": "2026-08-11T01:18:43.9836669-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-11T01:18:43.9836669-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": "dcd581ef-6bfd-4b44-8519-eef1fc74e7a2",
"CreateDate": "2026-08-11T01:18:43.9836669-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-11T01:18:43.9836669-07:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "642eb9d4-c2f6-4a6f-8bcf-d57416f056cd",
"CreateDate": "2026-08-11T01:18:43.9836669-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-11T01:18:43.9836669-07:00",
"LastModifiedUser": "sample string 7"
},
{
"PropertyId": "0333a66c-c940-4ac8-bb83-a9384a4ef6a9",
"Asset": {
"AssetId": "7360b974-529d-4941-863e-f1908cad4387",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "b723b023-0345-4dce-9bde-9033ac476fd3",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "13def643-5411-4666-b319-09b56f07586d",
"CreateDate": "2026-08-11T01:18:43.9836669-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-11T01:18:43.9836669-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "1360fbc2-d8e3-490f-87d1-973f131da5e6",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-11T01:18:43.9836669-07:00",
"MeasurementValueNeededDate": "2026-08-11T01:18:43.9836669-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5f45fa73-00a4-4e13-a228-09f70aa0aa0c",
"CreateDate": "2026-08-11T01:18:43.9836669-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-11T01:18:43.9836669-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-08-11T01:18:43.9836669-07:00",
"MeasurementValueNeededDate": "2026-08-11T01:18:43.9836669-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "b24ff61f-a7b0-4920-a48d-c7045b106d62",
"CreateDate": "2026-08-11T01:18:43.9836669-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T01:18:43.9836669-07:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"PropertyType": {
"PropertyTypeId": "f269bd21-efd4-46db-8e32-1ceb6eadcc5c",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "b723b023-0345-4dce-9bde-9033ac476fd3",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "13def643-5411-4666-b319-09b56f07586d",
"CreateDate": "2026-08-11T01:18:43.9836669-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-11T01:18:43.9836669-07:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "07295099-117c-426e-830b-fa9b8f2c334a",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "32675581-28ab-4d5e-a178-1cae03de14d3",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "cb879544-5919-4aa2-bd3b-535faa642bf8",
"CreateDate": "2026-08-11T01:18:43.9836669-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-11T01:18:43.9836669-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": "dcd581ef-6bfd-4b44-8519-eef1fc74e7a2",
"CreateDate": "2026-08-11T01:18:43.9836669-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-11T01:18:43.9836669-07:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "642eb9d4-c2f6-4a6f-8bcf-d57416f056cd",
"CreateDate": "2026-08-11T01:18:43.9836669-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-11T01:18:43.9836669-07:00",
"LastModifiedUser": "sample string 7"
}
],
"Total": 1,
"Message": "sample string 1"
}