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": "fe86c4ec-a7c3-42d7-963d-f33e775faa04",
"Asset": {
"AssetId": "3370ee34-2c03-4050-b6c8-6ae80b45efaf",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "1cd8041f-79ac-465d-b624-d591fd6920e5",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0ea6bd8b-7dff-447e-b9d7-ccbe39016844",
"CreateDate": "2026-06-16T00:34:57.8867396-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-16T00:34:57.8867396-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "8c54ee2d-07ec-4db5-bcc5-761ac90c59ec",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-16T00:34:57.8867396-07:00",
"MeasurementValueNeededDate": "2026-06-16T00:34:57.8867396-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f46d6eb3-b765-452f-a57c-1e0ae7677a87",
"CreateDate": "2026-06-16T00:34:57.8867396-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-16T00:34:57.8867396-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-06-16T00:34:57.8867396-07:00",
"MeasurementValueNeededDate": "2026-06-16T00:34:57.8867396-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "254b2734-d123-4187-8572-5e94ee8336d9",
"CreateDate": "2026-06-16T00:34:57.8867396-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-16T00:34:57.8867396-07:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"PropertyType": {
"PropertyTypeId": "80e697ed-2318-4dcb-b44b-35320acdfe7c",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "1cd8041f-79ac-465d-b624-d591fd6920e5",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0ea6bd8b-7dff-447e-b9d7-ccbe39016844",
"CreateDate": "2026-06-16T00:34:57.8867396-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-16T00:34:57.8867396-07:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "9b375ba4-90ce-4725-85db-1cabbfb7cdd3",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "c269b829-b518-40c5-a281-5b74764c204c",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5b86ff2c-354f-4f26-9c25-35954acbc0af",
"CreateDate": "2026-06-16T00:34:57.8867396-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-16T00:34:57.8867396-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": "0e466991-3bfb-4a5c-95e8-d89fc87eb4c5",
"CreateDate": "2026-06-16T00:34:57.8867396-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-16T00:34:57.8867396-07:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1d8aff82-c53d-4b9f-8148-0c3d438d0983",
"CreateDate": "2026-06-16T00:34:57.8867396-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-16T00:34:57.8867396-07:00",
"LastModifiedUser": "sample string 7"
},
{
"PropertyId": "fe86c4ec-a7c3-42d7-963d-f33e775faa04",
"Asset": {
"AssetId": "3370ee34-2c03-4050-b6c8-6ae80b45efaf",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "1cd8041f-79ac-465d-b624-d591fd6920e5",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0ea6bd8b-7dff-447e-b9d7-ccbe39016844",
"CreateDate": "2026-06-16T00:34:57.8867396-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-16T00:34:57.8867396-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "8c54ee2d-07ec-4db5-bcc5-761ac90c59ec",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-16T00:34:57.8867396-07:00",
"MeasurementValueNeededDate": "2026-06-16T00:34:57.8867396-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f46d6eb3-b765-452f-a57c-1e0ae7677a87",
"CreateDate": "2026-06-16T00:34:57.8867396-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-16T00:34:57.8867396-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-06-16T00:34:57.8867396-07:00",
"MeasurementValueNeededDate": "2026-06-16T00:34:57.8867396-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "254b2734-d123-4187-8572-5e94ee8336d9",
"CreateDate": "2026-06-16T00:34:57.8867396-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-16T00:34:57.8867396-07:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"PropertyType": {
"PropertyTypeId": "80e697ed-2318-4dcb-b44b-35320acdfe7c",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "1cd8041f-79ac-465d-b624-d591fd6920e5",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0ea6bd8b-7dff-447e-b9d7-ccbe39016844",
"CreateDate": "2026-06-16T00:34:57.8867396-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-16T00:34:57.8867396-07:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "9b375ba4-90ce-4725-85db-1cabbfb7cdd3",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "c269b829-b518-40c5-a281-5b74764c204c",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5b86ff2c-354f-4f26-9c25-35954acbc0af",
"CreateDate": "2026-06-16T00:34:57.8867396-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-16T00:34:57.8867396-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": "0e466991-3bfb-4a5c-95e8-d89fc87eb4c5",
"CreateDate": "2026-06-16T00:34:57.8867396-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-16T00:34:57.8867396-07:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1d8aff82-c53d-4b9f-8148-0c3d438d0983",
"CreateDate": "2026-06-16T00:34:57.8867396-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-16T00:34:57.8867396-07:00",
"LastModifiedUser": "sample string 7"
}
],
"Total": 1,
"Message": "sample string 1"
}