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": "8b4f086e-f2c2-4a6c-b674-fb7877ba872c",
"Asset": {
"AssetId": "7ee73501-852b-44d8-b1b7-48e28f8674a7",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "6cd5c9c0-7bbe-416f-9726-554eee36f04e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7ef2c6d3-cba7-4844-90cb-1e70de960885",
"CreateDate": "2024-12-08T05:53:28.7480624-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-12-08T05:53:28.7480624-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "52c2947a-135b-4b02-a680-ca71f844dcc5",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-12-08T05:53:28.7480624-08:00",
"MeasurementValueNeededDate": "2024-12-08T05:53:28.7480624-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a6443070-e8c7-43f0-b037-7a46a2f3f5f1",
"CreateDate": "2024-12-08T05:53:28.7480624-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-08T05:53:28.7480624-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2024-12-08T05:53:28.7480624-08:00",
"MeasurementValueNeededDate": "2024-12-08T05:53:28.7480624-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "36f22c9c-9514-4cc3-b19a-b4cf8fc65615",
"CreateDate": "2024-12-08T05:53:28.7480624-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-12-08T05:53:28.7480624-08:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"DisplayText": "sample string 2",
"PropertyType": {
"PropertyTypeId": "12880f48-bd88-43da-9607-9e68ea773e5a",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "6cd5c9c0-7bbe-416f-9726-554eee36f04e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7ef2c6d3-cba7-4844-90cb-1e70de960885",
"CreateDate": "2024-12-08T05:53:28.7480624-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-12-08T05:53:28.7480624-08:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "cc4a5c60-d289-4338-b465-c79bea9a1e0e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "65c40b9b-085e-48ee-8b7d-76039f996885",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "8f74f4f0-49d3-4518-bdc3-2ff90715ec4e",
"CreateDate": "2024-12-08T05:53:28.7480624-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-08T05:53:28.7480624-08:00",
"LastModifiedUser": "sample string 6"
},
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "12214afc-be41-4629-9e2d-87fd955edba1",
"FieldId": "5b238f4e-56df-4e89-9b84-34cf194dc628",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "12214afc-be41-4629-9e2d-87fd955edba1",
"FieldId": "5b238f4e-56df-4e89-9b84-34cf194dc628",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"SourceSystemId": "sample string 4",
"CompanyId": "a19b6f4d-a9f0-4d6d-8d6b-79f089b9dbda",
"CreateDate": "2024-12-08T05:53:28.7480624-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-12-08T05:53:28.7480624-08:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8b9e03fb-c20f-4dc1-82c4-b0143e6064aa",
"CreateDate": "2024-12-08T05:53:28.7480624-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-12-08T05:53:28.7480624-08:00",
"LastModifiedUser": "sample string 8"
},
{
"PropertyId": "8b4f086e-f2c2-4a6c-b674-fb7877ba872c",
"Asset": {
"AssetId": "7ee73501-852b-44d8-b1b7-48e28f8674a7",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "6cd5c9c0-7bbe-416f-9726-554eee36f04e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7ef2c6d3-cba7-4844-90cb-1e70de960885",
"CreateDate": "2024-12-08T05:53:28.7480624-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-12-08T05:53:28.7480624-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "52c2947a-135b-4b02-a680-ca71f844dcc5",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-12-08T05:53:28.7480624-08:00",
"MeasurementValueNeededDate": "2024-12-08T05:53:28.7480624-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a6443070-e8c7-43f0-b037-7a46a2f3f5f1",
"CreateDate": "2024-12-08T05:53:28.7480624-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-08T05:53:28.7480624-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2024-12-08T05:53:28.7480624-08:00",
"MeasurementValueNeededDate": "2024-12-08T05:53:28.7480624-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "36f22c9c-9514-4cc3-b19a-b4cf8fc65615",
"CreateDate": "2024-12-08T05:53:28.7480624-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-12-08T05:53:28.7480624-08:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"DisplayText": "sample string 2",
"PropertyType": {
"PropertyTypeId": "12880f48-bd88-43da-9607-9e68ea773e5a",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "6cd5c9c0-7bbe-416f-9726-554eee36f04e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7ef2c6d3-cba7-4844-90cb-1e70de960885",
"CreateDate": "2024-12-08T05:53:28.7480624-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-12-08T05:53:28.7480624-08:00",
"LastModifiedUser": "sample string 7"
},
"DataType": {
"DataTypeId": "cc4a5c60-d289-4338-b465-c79bea9a1e0e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "65c40b9b-085e-48ee-8b7d-76039f996885",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "8f74f4f0-49d3-4518-bdc3-2ff90715ec4e",
"CreateDate": "2024-12-08T05:53:28.7480624-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-08T05:53:28.7480624-08:00",
"LastModifiedUser": "sample string 6"
},
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "12214afc-be41-4629-9e2d-87fd955edba1",
"FieldId": "5b238f4e-56df-4e89-9b84-34cf194dc628",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "12214afc-be41-4629-9e2d-87fd955edba1",
"FieldId": "5b238f4e-56df-4e89-9b84-34cf194dc628",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"SourceSystemId": "sample string 4",
"CompanyId": "a19b6f4d-a9f0-4d6d-8d6b-79f089b9dbda",
"CreateDate": "2024-12-08T05:53:28.7480624-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-12-08T05:53:28.7480624-08:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8b9e03fb-c20f-4dc1-82c4-b0143e6064aa",
"CreateDate": "2024-12-08T05:53:28.7480624-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-12-08T05:53:28.7480624-08:00",
"LastModifiedUser": "sample string 8"
}
],
"Total": 1,
"Message": "sample string 1"
}