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 DataFilter |
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": "1c2749c0-cd4d-45a7-ba94-9cd088e1fd01",
"Asset": {
"AssetId": "0c7c2e87-dbe6-4c77-b181-74e85bbd8188",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "013076d3-589c-4f77-8afc-20f014116966",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7bf0380b-d0d3-4d5d-ba51-31439aa1849c",
"CreateDate": "2021-04-17T08:29:24.5489083-07:00",
"CreateUser": "sample string 6",
"CreateMachine": "sample string 7",
"LastModifiedDate": "2021-04-17T08:29:24.5489083-07:00",
"LastModifiedUser": "sample string 8",
"LastModifiedMachine": "sample string 9"
},
"AssetGroup": {
"AssetGroupId": "429d089d-8aca-4a4c-b40d-2ca871f977da",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2021-04-17T08:29:24.5489083-07:00",
"MeasurementValueNeededDate": "2021-04-17T08:29:24.5489083-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "871e335b-7952-4133-9091-db27d6b7acbb",
"CreateDate": "2021-04-17T08:29:24.5489083-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T08:29:24.5489083-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
"ParentAsset": null,
"WellKnownText": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2021-04-17T08:29:24.5489083-07:00",
"MeasurementValueNeededDate": "2021-04-17T08:29:24.5489083-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "d9d128e2-27a3-47ef-8ff5-9db3f79f1b2c",
"CreateDate": "2021-04-17T08:29:24.5489083-07:00",
"CreateUser": "sample string 7",
"CreateMachine": "sample string 8",
"LastModifiedDate": "2021-04-17T08:29:24.5489083-07:00",
"LastModifiedUser": "sample string 9",
"LastModifiedMachine": "sample string 10"
},
"ValueText": "sample string 1",
"PropertyType": {
"PropertyTypeId": "96cebe58-8fa3-4f72-9915-c36caeebaad7",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "013076d3-589c-4f77-8afc-20f014116966",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7bf0380b-d0d3-4d5d-ba51-31439aa1849c",
"CreateDate": "2021-04-17T08:29:24.5489083-07:00",
"CreateUser": "sample string 6",
"CreateMachine": "sample string 7",
"LastModifiedDate": "2021-04-17T08:29:24.5489083-07:00",
"LastModifiedUser": "sample string 8",
"LastModifiedMachine": "sample string 9"
},
"DataType": {
"DataTypeId": "1363140e-f600-43ac-82bc-cd56d0f03d59",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "2856ed5d-e12d-4ed0-90b9-cdfc9bfdf815",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a219023d-4a53-4416-bcb0-144968e0f652",
"CreateDate": "2021-04-17T08:29:24.5489083-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T08:29:24.5489083-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"SourceSystemId": "sample string 4",
"CompanyId": "766cbee1-fcc2-4fd5-a776-ab8b6f2054b8",
"CreateDate": "2021-04-17T08:29:24.5489083-07:00",
"CreateUser": "sample string 6",
"CreateMachine": "sample string 7",
"LastModifiedDate": "2021-04-17T08:29:24.5489083-07:00",
"LastModifiedUser": "sample string 8",
"LastModifiedMachine": "sample string 9"
},
"IsValid": true,
"IsValidMessage": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d165ffc9-3449-4995-985a-90cd44c60d09",
"CreateDate": "2021-04-17T08:29:24.5489083-07:00",
"CreateUser": "sample string 6",
"CreateMachine": "sample string 7",
"LastModifiedDate": "2021-04-17T08:29:24.5489083-07:00",
"LastModifiedUser": "sample string 8",
"LastModifiedMachine": "sample string 9"
},
{
"PropertyId": "1c2749c0-cd4d-45a7-ba94-9cd088e1fd01",
"Asset": {
"AssetId": "0c7c2e87-dbe6-4c77-b181-74e85bbd8188",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "013076d3-589c-4f77-8afc-20f014116966",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7bf0380b-d0d3-4d5d-ba51-31439aa1849c",
"CreateDate": "2021-04-17T08:29:24.5489083-07:00",
"CreateUser": "sample string 6",
"CreateMachine": "sample string 7",
"LastModifiedDate": "2021-04-17T08:29:24.5489083-07:00",
"LastModifiedUser": "sample string 8",
"LastModifiedMachine": "sample string 9"
},
"AssetGroup": {
"AssetGroupId": "429d089d-8aca-4a4c-b40d-2ca871f977da",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2021-04-17T08:29:24.5489083-07:00",
"MeasurementValueNeededDate": "2021-04-17T08:29:24.5489083-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "871e335b-7952-4133-9091-db27d6b7acbb",
"CreateDate": "2021-04-17T08:29:24.5489083-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T08:29:24.5489083-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
"ParentAsset": null,
"WellKnownText": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2021-04-17T08:29:24.5489083-07:00",
"MeasurementValueNeededDate": "2021-04-17T08:29:24.5489083-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "d9d128e2-27a3-47ef-8ff5-9db3f79f1b2c",
"CreateDate": "2021-04-17T08:29:24.5489083-07:00",
"CreateUser": "sample string 7",
"CreateMachine": "sample string 8",
"LastModifiedDate": "2021-04-17T08:29:24.5489083-07:00",
"LastModifiedUser": "sample string 9",
"LastModifiedMachine": "sample string 10"
},
"ValueText": "sample string 1",
"PropertyType": {
"PropertyTypeId": "96cebe58-8fa3-4f72-9915-c36caeebaad7",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "013076d3-589c-4f77-8afc-20f014116966",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7bf0380b-d0d3-4d5d-ba51-31439aa1849c",
"CreateDate": "2021-04-17T08:29:24.5489083-07:00",
"CreateUser": "sample string 6",
"CreateMachine": "sample string 7",
"LastModifiedDate": "2021-04-17T08:29:24.5489083-07:00",
"LastModifiedUser": "sample string 8",
"LastModifiedMachine": "sample string 9"
},
"DataType": {
"DataTypeId": "1363140e-f600-43ac-82bc-cd56d0f03d59",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "2856ed5d-e12d-4ed0-90b9-cdfc9bfdf815",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a219023d-4a53-4416-bcb0-144968e0f652",
"CreateDate": "2021-04-17T08:29:24.5489083-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T08:29:24.5489083-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"SourceSystemId": "sample string 4",
"CompanyId": "766cbee1-fcc2-4fd5-a776-ab8b6f2054b8",
"CreateDate": "2021-04-17T08:29:24.5489083-07:00",
"CreateUser": "sample string 6",
"CreateMachine": "sample string 7",
"LastModifiedDate": "2021-04-17T08:29:24.5489083-07:00",
"LastModifiedUser": "sample string 8",
"LastModifiedMachine": "sample string 9"
},
"IsValid": true,
"IsValidMessage": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d165ffc9-3449-4995-985a-90cd44c60d09",
"CreateDate": "2021-04-17T08:29:24.5489083-07:00",
"CreateUser": "sample string 6",
"CreateMachine": "sample string 7",
"LastModifiedDate": "2021-04-17T08:29:24.5489083-07:00",
"LastModifiedUser": "sample string 8",
"LastModifiedMachine": "sample string 9"
}
],
"Total": 1,
"Message": "sample string 1"
}