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": "bcc61993-e9a6-4390-beba-bab5144cda2a",
"Asset": {
"AssetId": "9c082198-4a57-42e2-b1aa-9373f6091201",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "c4bcfeac-9315-4167-a960-2dc31243fadc",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "36931484-a891-4697-8398-6502642cd697",
"CreateDate": "2026-01-21T01:40:00.5497182-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-21T01:40:00.5497182-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "00dce56a-c732-45c3-ad28-0222557b062e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-21T01:40:00.5497182-08:00",
"MeasurementValueNeededDate": "2026-01-21T01:40:00.5497182-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8d1d93f8-82d0-467f-b110-7565bd5c9f55",
"CreateDate": "2026-01-21T01:40:00.5497182-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-21T01:40:00.5497182-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-01-21T01:40:00.5497182-08:00",
"MeasurementValueNeededDate": "2026-01-21T01:40:00.5497182-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "5c3cc364-3307-4632-abe3-d9270423269a",
"CreateDate": "2026-01-21T01:40:00.5497182-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-21T01:40:00.5497182-08:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"DisplayText": "sample string 2",
"PropertyType": {
"PropertyTypeId": "e2da2e5a-6295-46e8-aa1f-cd89625d7d75",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "c4bcfeac-9315-4167-a960-2dc31243fadc",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "36931484-a891-4697-8398-6502642cd697",
"CreateDate": "2026-01-21T01:40:00.5497182-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-21T01:40:00.5497182-08:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "7b1e7fa1-5b30-4e44-8777-69f20e5397a1",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "729efa92-e50f-49d9-9113-37bb6fbc03d3",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "7fc2bef3-e523-4c5e-a6d6-5cb268b2e434",
"CreateDate": "2026-01-21T01:40:00.5497182-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-21T01:40:00.5497182-08:00",
"LastModifiedUser": "sample string 6"
},
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "b0275e30-7d4e-4f87-a15d-87fa635a41c3",
"FieldId": "702af521-b461-4d9a-a5d2-cc168a7d2dbd",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "b0275e30-7d4e-4f87-a15d-87fa635a41c3",
"FieldId": "702af521-b461-4d9a-a5d2-cc168a7d2dbd",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"SourceSystemId": "sample string 4",
"CompanyId": "8d6529f3-8307-4ff8-9d18-2848237f17e4",
"CreateDate": "2026-01-21T01:40:00.5497182-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-21T01:40:00.5497182-08:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5cf478d1-1aed-4315-89d5-173eb124f795",
"CreateDate": "2026-01-21T01:40:00.5497182-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-21T01:40:00.5497182-08:00",
"LastModifiedUser": "sample string 8"
},
{
"PropertyId": "bcc61993-e9a6-4390-beba-bab5144cda2a",
"Asset": {
"AssetId": "9c082198-4a57-42e2-b1aa-9373f6091201",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "c4bcfeac-9315-4167-a960-2dc31243fadc",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "36931484-a891-4697-8398-6502642cd697",
"CreateDate": "2026-01-21T01:40:00.5497182-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-21T01:40:00.5497182-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "00dce56a-c732-45c3-ad28-0222557b062e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-21T01:40:00.5497182-08:00",
"MeasurementValueNeededDate": "2026-01-21T01:40:00.5497182-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8d1d93f8-82d0-467f-b110-7565bd5c9f55",
"CreateDate": "2026-01-21T01:40:00.5497182-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-21T01:40:00.5497182-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-01-21T01:40:00.5497182-08:00",
"MeasurementValueNeededDate": "2026-01-21T01:40:00.5497182-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "5c3cc364-3307-4632-abe3-d9270423269a",
"CreateDate": "2026-01-21T01:40:00.5497182-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-21T01:40:00.5497182-08:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"DisplayText": "sample string 2",
"PropertyType": {
"PropertyTypeId": "e2da2e5a-6295-46e8-aa1f-cd89625d7d75",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "c4bcfeac-9315-4167-a960-2dc31243fadc",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "36931484-a891-4697-8398-6502642cd697",
"CreateDate": "2026-01-21T01:40:00.5497182-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-21T01:40:00.5497182-08:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "7b1e7fa1-5b30-4e44-8777-69f20e5397a1",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "729efa92-e50f-49d9-9113-37bb6fbc03d3",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "7fc2bef3-e523-4c5e-a6d6-5cb268b2e434",
"CreateDate": "2026-01-21T01:40:00.5497182-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-21T01:40:00.5497182-08:00",
"LastModifiedUser": "sample string 6"
},
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "b0275e30-7d4e-4f87-a15d-87fa635a41c3",
"FieldId": "702af521-b461-4d9a-a5d2-cc168a7d2dbd",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "b0275e30-7d4e-4f87-a15d-87fa635a41c3",
"FieldId": "702af521-b461-4d9a-a5d2-cc168a7d2dbd",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"SourceSystemId": "sample string 4",
"CompanyId": "8d6529f3-8307-4ff8-9d18-2848237f17e4",
"CreateDate": "2026-01-21T01:40:00.5497182-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-21T01:40:00.5497182-08:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5cf478d1-1aed-4315-89d5-173eb124f795",
"CreateDate": "2026-01-21T01:40:00.5497182-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-21T01:40:00.5497182-08:00",
"LastModifiedUser": "sample string 8"
}
],
"Total": 1,
"Message": "sample string 1"
}