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": "cd596e87-0275-496e-810a-8e22e30455fc",
"Asset": {
"AssetId": "3f76cc1e-0291-4c34-96bf-323be0d4a35d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "e100a8c9-a190-4f71-849a-2cceabef1914",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3b6bf494-de06-472f-966d-168d25d965c7",
"CreateDate": "2025-03-18T17:13:17.6638156-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-03-18T17:13:17.6638156-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "87116bc4-6abc-455f-a9c2-51d16a5f4524",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-03-18T17:13:17.6638156-07:00",
"MeasurementValueNeededDate": "2025-03-18T17:13:17.6638156-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "1632d7dc-55b4-4c16-ab03-a6fe8126233b",
"CreateDate": "2025-03-18T17:13:17.6638156-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-03-18T17:13:17.6638156-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-03-18T17:13:17.6638156-07:00",
"MeasurementValueNeededDate": "2025-03-18T17:13:17.6638156-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "83038297-1bda-4fa7-b4cf-b1ce1d798879",
"CreateDate": "2025-03-18T17:13:17.6638156-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-03-18T17:13:17.6638156-07:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"DisplayText": "sample string 2",
"PropertyType": {
"PropertyTypeId": "2bf41a5a-f022-44b1-b155-f84740dab555",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "e100a8c9-a190-4f71-849a-2cceabef1914",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3b6bf494-de06-472f-966d-168d25d965c7",
"CreateDate": "2025-03-18T17:13:17.6638156-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-03-18T17:13:17.6638156-07:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "562d8ee2-3fa1-4d4f-af3b-90603fe6818f",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b3c1119b-f049-422c-be67-36616a3c1bce",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5d55f388-b9ff-45d6-90a3-dc9490cb2c38",
"CreateDate": "2025-03-18T17:13:17.6638156-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-03-18T17:13:17.6638156-07:00",
"LastModifiedUser": "sample string 6"
},
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "8b68ecbf-5c96-417d-b500-0d3511e5c67c",
"FieldId": "d130fb63-5291-45a7-9b99-e634ff42f0e1",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "8b68ecbf-5c96-417d-b500-0d3511e5c67c",
"FieldId": "d130fb63-5291-45a7-9b99-e634ff42f0e1",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"SourceSystemId": "sample string 4",
"CompanyId": "154f6fe1-51f2-4260-afe0-03a1ae25f1e7",
"CreateDate": "2025-03-18T17:13:17.6638156-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-03-18T17:13:17.6638156-07:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1821e22b-88b2-45f7-9e1a-aae8d3aab108",
"CreateDate": "2025-03-18T17:13:17.6638156-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-03-18T17:13:17.6638156-07:00",
"LastModifiedUser": "sample string 8"
},
{
"PropertyId": "cd596e87-0275-496e-810a-8e22e30455fc",
"Asset": {
"AssetId": "3f76cc1e-0291-4c34-96bf-323be0d4a35d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "e100a8c9-a190-4f71-849a-2cceabef1914",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3b6bf494-de06-472f-966d-168d25d965c7",
"CreateDate": "2025-03-18T17:13:17.6638156-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-03-18T17:13:17.6638156-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "87116bc4-6abc-455f-a9c2-51d16a5f4524",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-03-18T17:13:17.6638156-07:00",
"MeasurementValueNeededDate": "2025-03-18T17:13:17.6638156-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "1632d7dc-55b4-4c16-ab03-a6fe8126233b",
"CreateDate": "2025-03-18T17:13:17.6638156-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-03-18T17:13:17.6638156-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-03-18T17:13:17.6638156-07:00",
"MeasurementValueNeededDate": "2025-03-18T17:13:17.6638156-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "83038297-1bda-4fa7-b4cf-b1ce1d798879",
"CreateDate": "2025-03-18T17:13:17.6638156-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-03-18T17:13:17.6638156-07:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"DisplayText": "sample string 2",
"PropertyType": {
"PropertyTypeId": "2bf41a5a-f022-44b1-b155-f84740dab555",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "e100a8c9-a190-4f71-849a-2cceabef1914",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3b6bf494-de06-472f-966d-168d25d965c7",
"CreateDate": "2025-03-18T17:13:17.6638156-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-03-18T17:13:17.6638156-07:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "562d8ee2-3fa1-4d4f-af3b-90603fe6818f",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b3c1119b-f049-422c-be67-36616a3c1bce",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5d55f388-b9ff-45d6-90a3-dc9490cb2c38",
"CreateDate": "2025-03-18T17:13:17.6638156-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-03-18T17:13:17.6638156-07:00",
"LastModifiedUser": "sample string 6"
},
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "8b68ecbf-5c96-417d-b500-0d3511e5c67c",
"FieldId": "d130fb63-5291-45a7-9b99-e634ff42f0e1",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "8b68ecbf-5c96-417d-b500-0d3511e5c67c",
"FieldId": "d130fb63-5291-45a7-9b99-e634ff42f0e1",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"SourceSystemId": "sample string 4",
"CompanyId": "154f6fe1-51f2-4260-afe0-03a1ae25f1e7",
"CreateDate": "2025-03-18T17:13:17.6638156-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-03-18T17:13:17.6638156-07:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1821e22b-88b2-45f7-9e1a-aae8d3aab108",
"CreateDate": "2025-03-18T17:13:17.6638156-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-03-18T17:13:17.6638156-07:00",
"LastModifiedUser": "sample string 8"
}
],
"Total": 1,
"Message": "sample string 1"
}