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": "87789402-b1e2-4cb7-b05b-689cf1ef2b42",
"Asset": {
"AssetId": "e40413e1-add3-4e3e-bcd4-08a077b192aa",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "97db5650-b015-41a8-b81c-ac64f5185446",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "27a16011-2de7-411e-920f-c80e6dc3f5c3",
"CreateDate": "2026-08-25T01:51:28.4375849-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-25T01:51:28.4375849-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "58c78a12-02a9-4511-a0c0-dce73474645f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-25T01:51:28.4375849-07:00",
"MeasurementValueNeededDate": "2026-08-25T01:51:28.4375849-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b2c15daa-d02a-4a2a-b91a-48ef8720b51f",
"CreateDate": "2026-08-25T01:51:28.4375849-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-25T01:51:28.4375849-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-08-25T01:51:28.4375849-07:00",
"MeasurementValueNeededDate": "2026-08-25T01:51:28.4375849-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "610d294a-5fbc-476c-9694-697b29eac481",
"CreateDate": "2026-08-25T01:51:28.4375849-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-25T01:51:28.4375849-07:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"PropertyType": {
"PropertyTypeId": "4a0fc820-31b3-4d58-8157-1914b05a8439",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "97db5650-b015-41a8-b81c-ac64f5185446",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "27a16011-2de7-411e-920f-c80e6dc3f5c3",
"CreateDate": "2026-08-25T01:51:28.4375849-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-25T01:51:28.4375849-07:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "1ed353c7-11da-4764-a8ce-df65d9b2aec9",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "2e02ce94-0f58-4f6c-ab26-f56724b5b408",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d2d3c735-830d-4ee0-9618-a06f77e8b0ac",
"CreateDate": "2026-08-25T01:51:28.4375849-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-25T01:51:28.4375849-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": "65bf1b01-c8d3-4348-86ef-aba5b7ed0ca3",
"CreateDate": "2026-08-25T01:51:28.4375849-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-25T01:51:28.4375849-07:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c5c32bd5-f4ea-42b0-b770-c1eb8ce9baac",
"CreateDate": "2026-08-25T01:51:28.4375849-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-25T01:51:28.4375849-07:00",
"LastModifiedUser": "sample string 7"
},
{
"PropertyId": "87789402-b1e2-4cb7-b05b-689cf1ef2b42",
"Asset": {
"AssetId": "e40413e1-add3-4e3e-bcd4-08a077b192aa",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "97db5650-b015-41a8-b81c-ac64f5185446",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "27a16011-2de7-411e-920f-c80e6dc3f5c3",
"CreateDate": "2026-08-25T01:51:28.4375849-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-25T01:51:28.4375849-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "58c78a12-02a9-4511-a0c0-dce73474645f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-25T01:51:28.4375849-07:00",
"MeasurementValueNeededDate": "2026-08-25T01:51:28.4375849-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b2c15daa-d02a-4a2a-b91a-48ef8720b51f",
"CreateDate": "2026-08-25T01:51:28.4375849-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-25T01:51:28.4375849-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-08-25T01:51:28.4375849-07:00",
"MeasurementValueNeededDate": "2026-08-25T01:51:28.4375849-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "610d294a-5fbc-476c-9694-697b29eac481",
"CreateDate": "2026-08-25T01:51:28.4375849-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-25T01:51:28.4375849-07:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"PropertyType": {
"PropertyTypeId": "4a0fc820-31b3-4d58-8157-1914b05a8439",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "97db5650-b015-41a8-b81c-ac64f5185446",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "27a16011-2de7-411e-920f-c80e6dc3f5c3",
"CreateDate": "2026-08-25T01:51:28.4375849-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-25T01:51:28.4375849-07:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "1ed353c7-11da-4764-a8ce-df65d9b2aec9",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "2e02ce94-0f58-4f6c-ab26-f56724b5b408",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d2d3c735-830d-4ee0-9618-a06f77e8b0ac",
"CreateDate": "2026-08-25T01:51:28.4375849-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-25T01:51:28.4375849-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": "65bf1b01-c8d3-4348-86ef-aba5b7ed0ca3",
"CreateDate": "2026-08-25T01:51:28.4375849-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-25T01:51:28.4375849-07:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c5c32bd5-f4ea-42b0-b770-c1eb8ce9baac",
"CreateDate": "2026-08-25T01:51:28.4375849-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-25T01:51:28.4375849-07:00",
"LastModifiedUser": "sample string 7"
}
],
"Total": 1,
"Message": "sample string 1"
}