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": "b4cd03f4-6e2b-4648-9de5-1a668da83dff",
"Asset": {
"AssetId": "e4a173bf-c898-43ce-a4b0-a2a572e60a9d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "ac8e7ea8-6f2d-4a8b-aaa9-6dc0531c0a3f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c40fd4a0-252e-47c6-abb4-934df8542c2f",
"CreateDate": "2026-09-08T03:51:54.5167594-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-08T03:51:54.5167594-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "f88c6bec-f2b6-45da-a852-41cd3e18c1de",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-08T03:51:54.5167594-07:00",
"MeasurementValueNeededDate": "2026-09-08T03:51:54.5167594-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9005a263-fd4e-4309-b5e1-f92d8b795471",
"CreateDate": "2026-09-08T03:51:54.5167594-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-08T03:51:54.5167594-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-09-08T03:51:54.5167594-07:00",
"MeasurementValueNeededDate": "2026-09-08T03:51:54.5167594-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "c9b879a8-a4e4-4d9e-912f-6c163a5185b5",
"CreateDate": "2026-09-08T03:51:54.5167594-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-08T03:51:54.5167594-07:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"PropertyType": {
"PropertyTypeId": "8f1e6665-b0db-49dc-94f0-bd7ed7abd75f",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "ac8e7ea8-6f2d-4a8b-aaa9-6dc0531c0a3f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c40fd4a0-252e-47c6-abb4-934df8542c2f",
"CreateDate": "2026-09-08T03:51:54.5167594-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-08T03:51:54.5167594-07:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "db3e97c1-e4c6-46e2-bd9e-4eb40b80ff41",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "1094b873-1da6-43bb-832a-39374e3386a6",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "3066b6ae-d978-46ca-b4d7-9db572f166d2",
"CreateDate": "2026-09-08T03:51:54.5167594-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-08T03:51:54.5167594-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": "a3b2a51c-03f5-4f9b-be8b-ff0273811d62",
"CreateDate": "2026-09-08T03:51:54.5167594-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-08T03:51:54.5167594-07:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ef681062-4751-4dbf-a3ef-86c00633121a",
"CreateDate": "2026-09-08T03:51:54.5167594-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-08T03:51:54.5167594-07:00",
"LastModifiedUser": "sample string 7"
},
{
"PropertyId": "b4cd03f4-6e2b-4648-9de5-1a668da83dff",
"Asset": {
"AssetId": "e4a173bf-c898-43ce-a4b0-a2a572e60a9d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "ac8e7ea8-6f2d-4a8b-aaa9-6dc0531c0a3f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c40fd4a0-252e-47c6-abb4-934df8542c2f",
"CreateDate": "2026-09-08T03:51:54.5167594-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-08T03:51:54.5167594-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "f88c6bec-f2b6-45da-a852-41cd3e18c1de",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-08T03:51:54.5167594-07:00",
"MeasurementValueNeededDate": "2026-09-08T03:51:54.5167594-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9005a263-fd4e-4309-b5e1-f92d8b795471",
"CreateDate": "2026-09-08T03:51:54.5167594-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-08T03:51:54.5167594-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-09-08T03:51:54.5167594-07:00",
"MeasurementValueNeededDate": "2026-09-08T03:51:54.5167594-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "c9b879a8-a4e4-4d9e-912f-6c163a5185b5",
"CreateDate": "2026-09-08T03:51:54.5167594-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-08T03:51:54.5167594-07:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"PropertyType": {
"PropertyTypeId": "8f1e6665-b0db-49dc-94f0-bd7ed7abd75f",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "ac8e7ea8-6f2d-4a8b-aaa9-6dc0531c0a3f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c40fd4a0-252e-47c6-abb4-934df8542c2f",
"CreateDate": "2026-09-08T03:51:54.5167594-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-08T03:51:54.5167594-07:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "db3e97c1-e4c6-46e2-bd9e-4eb40b80ff41",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "1094b873-1da6-43bb-832a-39374e3386a6",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "3066b6ae-d978-46ca-b4d7-9db572f166d2",
"CreateDate": "2026-09-08T03:51:54.5167594-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-08T03:51:54.5167594-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": "a3b2a51c-03f5-4f9b-be8b-ff0273811d62",
"CreateDate": "2026-09-08T03:51:54.5167594-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-08T03:51:54.5167594-07:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ef681062-4751-4dbf-a3ef-86c00633121a",
"CreateDate": "2026-09-08T03:51:54.5167594-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-08T03:51:54.5167594-07:00",
"LastModifiedUser": "sample string 7"
}
],
"Total": 1,
"Message": "sample string 1"
}