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": "b0cc5329-0683-42cc-92b0-b996978a6592",
"Asset": {
"AssetId": "e156ceea-804f-44bd-84e4-36983abd948f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "bdd28c0e-3c51-4441-920b-aba7b2778360",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "58cfeecb-a73e-4322-b128-8d1a22f31ea7",
"CreateDate": "2026-11-17T11:48:18.9262729-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-17T11:48:18.9262729-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "ed7f1b21-702b-4065-8b93-9cba68239b9e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-17T11:48:18.9262729-08:00",
"MeasurementValueNeededDate": "2026-11-17T11:48:18.9262729-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "53f1d91b-4b27-4111-b7ee-32e98906777c",
"CreateDate": "2026-11-17T11:48:18.9262729-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-17T11:48:18.9262729-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-11-17T11:48:18.9262729-08:00",
"MeasurementValueNeededDate": "2026-11-17T11:48:18.9262729-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "956fc290-5d5f-4725-952d-2d0f501459c2",
"CreateDate": "2026-11-17T11:48:18.9262729-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-17T11:48:18.9262729-08:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"PropertyType": {
"PropertyTypeId": "763d8a17-ef4c-4def-b740-2919ef88b648",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "bdd28c0e-3c51-4441-920b-aba7b2778360",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "58cfeecb-a73e-4322-b128-8d1a22f31ea7",
"CreateDate": "2026-11-17T11:48:18.9262729-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-17T11:48:18.9262729-08:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "feed5d07-b3fc-4a5e-aba1-e1356b82dc0f",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "526654fa-f2a7-4e33-85de-c0b38cf213a6",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "af3f5404-0f30-4006-9419-30bf05039392",
"CreateDate": "2026-11-17T11:48:18.9262729-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-17T11:48:18.9262729-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": "0e95074f-83d0-4f51-b7f1-b3eaa1c9a680",
"CreateDate": "2026-11-17T11:48:18.9262729-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-17T11:48:18.9262729-08:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9a12279f-e0f0-47a1-a8ec-940ffb76bb6d",
"CreateDate": "2026-11-17T11:48:18.9262729-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-17T11:48:18.9262729-08:00",
"LastModifiedUser": "sample string 7"
},
{
"PropertyId": "b0cc5329-0683-42cc-92b0-b996978a6592",
"Asset": {
"AssetId": "e156ceea-804f-44bd-84e4-36983abd948f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "bdd28c0e-3c51-4441-920b-aba7b2778360",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "58cfeecb-a73e-4322-b128-8d1a22f31ea7",
"CreateDate": "2026-11-17T11:48:18.9262729-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-17T11:48:18.9262729-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "ed7f1b21-702b-4065-8b93-9cba68239b9e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-17T11:48:18.9262729-08:00",
"MeasurementValueNeededDate": "2026-11-17T11:48:18.9262729-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "53f1d91b-4b27-4111-b7ee-32e98906777c",
"CreateDate": "2026-11-17T11:48:18.9262729-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-17T11:48:18.9262729-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-11-17T11:48:18.9262729-08:00",
"MeasurementValueNeededDate": "2026-11-17T11:48:18.9262729-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "956fc290-5d5f-4725-952d-2d0f501459c2",
"CreateDate": "2026-11-17T11:48:18.9262729-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-17T11:48:18.9262729-08:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"PropertyType": {
"PropertyTypeId": "763d8a17-ef4c-4def-b740-2919ef88b648",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "bdd28c0e-3c51-4441-920b-aba7b2778360",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "58cfeecb-a73e-4322-b128-8d1a22f31ea7",
"CreateDate": "2026-11-17T11:48:18.9262729-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-17T11:48:18.9262729-08:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "feed5d07-b3fc-4a5e-aba1-e1356b82dc0f",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "526654fa-f2a7-4e33-85de-c0b38cf213a6",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "af3f5404-0f30-4006-9419-30bf05039392",
"CreateDate": "2026-11-17T11:48:18.9262729-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-17T11:48:18.9262729-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": "0e95074f-83d0-4f51-b7f1-b3eaa1c9a680",
"CreateDate": "2026-11-17T11:48:18.9262729-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-17T11:48:18.9262729-08:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9a12279f-e0f0-47a1-a8ec-940ffb76bb6d",
"CreateDate": "2026-11-17T11:48:18.9262729-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-17T11:48:18.9262729-08:00",
"LastModifiedUser": "sample string 7"
}
],
"Total": 1,
"Message": "sample string 1"
}