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": "3876ed56-068e-42b3-9e26-babd277788c6", "Asset": { "AssetId": "be0dc194-d6bc-4109-9108-6e4d8932b903", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "d70cdc9e-bfbb-4108-9e60-32df0939f5ee", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "f0bc17f1-b06e-4478-bda3-9460c0373df5", "CreateDate": "2023-12-01T12:24:02.7038402-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2023-12-01T12:24:02.7038402-08:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "fd62b90f-5970-45b2-a460-ca97de34309f", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2023-12-01T12:24:02.7038402-08:00", "MeasurementValueNeededDate": "2023-12-01T12:24:02.7038402-08:00", "SourceSystemId": "sample string 3", "CompanyId": "47787854-f7c6-4a25-8bdc-7592dac32260", "CreateDate": "2023-12-01T12:24:02.7038402-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-12-01T12:24:02.7038402-08:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2023-12-01T12:24:02.7038402-08:00", "MeasurementValueNeededDate": "2023-12-01T12:24:02.7038402-08:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "ec1fb93c-a32a-41a5-b0eb-71d54d96a12d", "CreateDate": "2023-12-01T12:24:02.7038402-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2023-12-01T12:24:02.7038402-08:00", "LastModifiedUser": "sample string 8" }, "ValueText": "sample string 1", "PropertyType": { "PropertyTypeId": "9c0c0909-6a6b-4091-8fd2-914ea6a8fa32", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "d70cdc9e-bfbb-4108-9e60-32df0939f5ee", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "f0bc17f1-b06e-4478-bda3-9460c0373df5", "CreateDate": "2023-12-01T12:24:02.7038402-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2023-12-01T12:24:02.7038402-08:00", "LastModifiedUser": "sample string 7" }, "DataType": { "DataTypeId": "f2d4bf82-f8c7-4d19-b2f7-c334f4ed80e5", "Name": "sample string 1" }, "Unit": { "UnitId": "aa571341-5b18-4600-88c1-20286527e39a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "32ab2980-3ea0-4a3e-a52c-0071689bd163", "CreateDate": "2023-12-01T12:24:02.7038402-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-12-01T12:24:02.7038402-08: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": "e6942bf0-50ab-4bd5-a7c7-cfbce6f40391", "CreateDate": "2023-12-01T12:24:02.7038402-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2023-12-01T12:24:02.7038402-08:00", "LastModifiedUser": "sample string 7" }, "IsValid": true, "IsValidMessage": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "680b8cab-79e2-43cd-9f70-df50532a0c58", "CreateDate": "2023-12-01T12:24:02.7038402-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2023-12-01T12:24:02.7038402-08:00", "LastModifiedUser": "sample string 7" }, { "PropertyId": "3876ed56-068e-42b3-9e26-babd277788c6", "Asset": { "AssetId": "be0dc194-d6bc-4109-9108-6e4d8932b903", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "d70cdc9e-bfbb-4108-9e60-32df0939f5ee", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "f0bc17f1-b06e-4478-bda3-9460c0373df5", "CreateDate": "2023-12-01T12:24:02.7038402-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2023-12-01T12:24:02.7038402-08:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "fd62b90f-5970-45b2-a460-ca97de34309f", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2023-12-01T12:24:02.7038402-08:00", "MeasurementValueNeededDate": "2023-12-01T12:24:02.7038402-08:00", "SourceSystemId": "sample string 3", "CompanyId": "47787854-f7c6-4a25-8bdc-7592dac32260", "CreateDate": "2023-12-01T12:24:02.7038402-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-12-01T12:24:02.7038402-08:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2023-12-01T12:24:02.7038402-08:00", "MeasurementValueNeededDate": "2023-12-01T12:24:02.7038402-08:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "ec1fb93c-a32a-41a5-b0eb-71d54d96a12d", "CreateDate": "2023-12-01T12:24:02.7038402-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2023-12-01T12:24:02.7038402-08:00", "LastModifiedUser": "sample string 8" }, "ValueText": "sample string 1", "PropertyType": { "PropertyTypeId": "9c0c0909-6a6b-4091-8fd2-914ea6a8fa32", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "d70cdc9e-bfbb-4108-9e60-32df0939f5ee", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "f0bc17f1-b06e-4478-bda3-9460c0373df5", "CreateDate": "2023-12-01T12:24:02.7038402-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2023-12-01T12:24:02.7038402-08:00", "LastModifiedUser": "sample string 7" }, "DataType": { "DataTypeId": "f2d4bf82-f8c7-4d19-b2f7-c334f4ed80e5", "Name": "sample string 1" }, "Unit": { "UnitId": "aa571341-5b18-4600-88c1-20286527e39a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "32ab2980-3ea0-4a3e-a52c-0071689bd163", "CreateDate": "2023-12-01T12:24:02.7038402-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-12-01T12:24:02.7038402-08: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": "e6942bf0-50ab-4bd5-a7c7-cfbce6f40391", "CreateDate": "2023-12-01T12:24:02.7038402-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2023-12-01T12:24:02.7038402-08:00", "LastModifiedUser": "sample string 7" }, "IsValid": true, "IsValidMessage": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "680b8cab-79e2-43cd-9f70-df50532a0c58", "CreateDate": "2023-12-01T12:24:02.7038402-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2023-12-01T12:24:02.7038402-08:00", "LastModifiedUser": "sample string 7" } ], "Total": 1, "Message": "sample string 1" }