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": "105efdc3-b41b-4e30-be2c-3815211f4536",
"Asset": {
"AssetId": "7c2fa0fa-40cf-42c5-8281-10876de63793",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "be80b8c3-10fa-4644-aa90-48c7386b6978",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2413ea78-2ea6-4995-8176-ddb35ae86c64",
"CreateDate": "2026-02-01T19:58:05.8502499-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-01T19:58:05.8502499-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "491112f7-5e26-4eb0-9989-6a8334a31390",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-01T19:58:05.8502499-08:00",
"MeasurementValueNeededDate": "2026-02-01T19:58:05.8502499-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e1c1cde9-fb29-4506-be4e-bcadf9d3b449",
"CreateDate": "2026-02-01T19:58:05.8502499-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-01T19:58:05.8502499-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-02-01T19:58:05.8502499-08:00",
"MeasurementValueNeededDate": "2026-02-01T19:58:05.8502499-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "c4f70da8-6208-4030-a284-3bab7d34022f",
"CreateDate": "2026-02-01T19:58:05.8502499-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-01T19:58:05.8502499-08:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"PropertyType": {
"PropertyTypeId": "4000d2bb-a59d-4917-b8e1-81a02884af63",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "be80b8c3-10fa-4644-aa90-48c7386b6978",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2413ea78-2ea6-4995-8176-ddb35ae86c64",
"CreateDate": "2026-02-01T19:58:05.8502499-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-01T19:58:05.8502499-08:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "8a518060-e38a-4220-b50e-3feda1866dd7",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "fa18a9c1-f2be-4f5f-8071-5552e6ac4d38",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5af692ad-6065-402f-a09c-fe38ed05e1bf",
"CreateDate": "2026-02-01T19:58:05.8502499-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-01T19:58:05.8502499-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": "511db061-2bbf-4545-9cc4-406f160a086b",
"CreateDate": "2026-02-01T19:58:05.8502499-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-01T19:58:05.8502499-08:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "6fba0c8a-d433-4248-bfe5-7009b9f8bff1",
"CreateDate": "2026-02-01T19:58:05.8502499-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-01T19:58:05.8502499-08:00",
"LastModifiedUser": "sample string 7"
},
{
"PropertyId": "105efdc3-b41b-4e30-be2c-3815211f4536",
"Asset": {
"AssetId": "7c2fa0fa-40cf-42c5-8281-10876de63793",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "be80b8c3-10fa-4644-aa90-48c7386b6978",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2413ea78-2ea6-4995-8176-ddb35ae86c64",
"CreateDate": "2026-02-01T19:58:05.8502499-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-01T19:58:05.8502499-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "491112f7-5e26-4eb0-9989-6a8334a31390",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-01T19:58:05.8502499-08:00",
"MeasurementValueNeededDate": "2026-02-01T19:58:05.8502499-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e1c1cde9-fb29-4506-be4e-bcadf9d3b449",
"CreateDate": "2026-02-01T19:58:05.8502499-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-01T19:58:05.8502499-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-02-01T19:58:05.8502499-08:00",
"MeasurementValueNeededDate": "2026-02-01T19:58:05.8502499-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "c4f70da8-6208-4030-a284-3bab7d34022f",
"CreateDate": "2026-02-01T19:58:05.8502499-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-01T19:58:05.8502499-08:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"PropertyType": {
"PropertyTypeId": "4000d2bb-a59d-4917-b8e1-81a02884af63",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "be80b8c3-10fa-4644-aa90-48c7386b6978",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2413ea78-2ea6-4995-8176-ddb35ae86c64",
"CreateDate": "2026-02-01T19:58:05.8502499-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-01T19:58:05.8502499-08:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "8a518060-e38a-4220-b50e-3feda1866dd7",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "fa18a9c1-f2be-4f5f-8071-5552e6ac4d38",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5af692ad-6065-402f-a09c-fe38ed05e1bf",
"CreateDate": "2026-02-01T19:58:05.8502499-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-01T19:58:05.8502499-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": "511db061-2bbf-4545-9cc4-406f160a086b",
"CreateDate": "2026-02-01T19:58:05.8502499-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-01T19:58:05.8502499-08:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "6fba0c8a-d433-4248-bfe5-7009b9f8bff1",
"CreateDate": "2026-02-01T19:58:05.8502499-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-01T19:58:05.8502499-08:00",
"LastModifiedUser": "sample string 7"
}
],
"Total": 1,
"Message": "sample string 1"
}