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": "bdcc3a47-6878-45cd-9a7d-34e7e17bd48f",
"Asset": {
"AssetId": "3e39e486-d36d-49d4-9f67-bbc1b6d01135",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "e1428840-738a-46ca-828c-1886bbfa47b4",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "08f63337-1ec0-4b1f-abe9-b1509efeaca8",
"CreateDate": "2026-03-03T20:40:30.1456893-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-03T20:40:30.1456893-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "f7410300-e163-4574-8fc4-7adf31947e71",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-03T20:40:30.1456893-08:00",
"MeasurementValueNeededDate": "2026-03-03T20:40:30.1456893-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "26bdcb3f-e662-427d-ad77-19c684839dbf",
"CreateDate": "2026-03-03T20:40:30.1456893-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-03T20:40:30.1456893-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-03-03T20:40:30.1456893-08:00",
"MeasurementValueNeededDate": "2026-03-03T20:40:30.1456893-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "bbd12b5e-d1f6-4913-8ad5-296593d09726",
"CreateDate": "2026-03-03T20:40:30.1456893-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-03T20:40:30.1456893-08:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"PropertyType": {
"PropertyTypeId": "61ec5097-fa27-46fe-bd08-76a56457364f",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "e1428840-738a-46ca-828c-1886bbfa47b4",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "08f63337-1ec0-4b1f-abe9-b1509efeaca8",
"CreateDate": "2026-03-03T20:40:30.1456893-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-03T20:40:30.1456893-08:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "de287dfa-3dfd-45d8-b2de-559da1552b08",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "3bf52856-5f70-4522-b102-d6f8fe961e8f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9d16b2dc-14f1-412d-9bab-ec560767ccba",
"CreateDate": "2026-03-03T20:40:30.1456893-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-03T20:40:30.1456893-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": "da7538de-3146-4149-8fc6-7191dc67db02",
"CreateDate": "2026-03-03T20:40:30.1456893-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-03T20:40:30.1456893-08:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "96d63b5b-09ad-498b-8a46-c2bc53e2bed0",
"CreateDate": "2026-03-03T20:40:30.1456893-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-03T20:40:30.1456893-08:00",
"LastModifiedUser": "sample string 7"
},
{
"PropertyId": "bdcc3a47-6878-45cd-9a7d-34e7e17bd48f",
"Asset": {
"AssetId": "3e39e486-d36d-49d4-9f67-bbc1b6d01135",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "e1428840-738a-46ca-828c-1886bbfa47b4",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "08f63337-1ec0-4b1f-abe9-b1509efeaca8",
"CreateDate": "2026-03-03T20:40:30.1456893-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-03T20:40:30.1456893-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "f7410300-e163-4574-8fc4-7adf31947e71",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-03T20:40:30.1456893-08:00",
"MeasurementValueNeededDate": "2026-03-03T20:40:30.1456893-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "26bdcb3f-e662-427d-ad77-19c684839dbf",
"CreateDate": "2026-03-03T20:40:30.1456893-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-03T20:40:30.1456893-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-03-03T20:40:30.1456893-08:00",
"MeasurementValueNeededDate": "2026-03-03T20:40:30.1456893-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "bbd12b5e-d1f6-4913-8ad5-296593d09726",
"CreateDate": "2026-03-03T20:40:30.1456893-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-03T20:40:30.1456893-08:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"PropertyType": {
"PropertyTypeId": "61ec5097-fa27-46fe-bd08-76a56457364f",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "e1428840-738a-46ca-828c-1886bbfa47b4",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "08f63337-1ec0-4b1f-abe9-b1509efeaca8",
"CreateDate": "2026-03-03T20:40:30.1456893-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-03T20:40:30.1456893-08:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "de287dfa-3dfd-45d8-b2de-559da1552b08",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "3bf52856-5f70-4522-b102-d6f8fe961e8f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9d16b2dc-14f1-412d-9bab-ec560767ccba",
"CreateDate": "2026-03-03T20:40:30.1456893-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-03T20:40:30.1456893-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": "da7538de-3146-4149-8fc6-7191dc67db02",
"CreateDate": "2026-03-03T20:40:30.1456893-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-03T20:40:30.1456893-08:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "96d63b5b-09ad-498b-8a46-c2bc53e2bed0",
"CreateDate": "2026-03-03T20:40:30.1456893-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-03T20:40:30.1456893-08:00",
"LastModifiedUser": "sample string 7"
}
],
"Total": 1,
"Message": "sample string 1"
}