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": "12f85deb-0b96-40e6-8994-a1e63cd3d106", "Asset": { "AssetId": "d8b33cd5-3fef-492d-b22f-26e027be024a", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "7543c0cc-6d9b-4e44-a6f9-5c2b86046658", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "85ce986f-8361-4ba1-b728-2ade13d911fb", "CreateDate": "2024-10-09T22:27:35.598188-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-10-09T22:27:35.598188-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "422154f5-d9ca-4f51-a000-fb1f0389a913", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-10-09T22:27:35.598188-07:00", "MeasurementValueNeededDate": "2024-10-09T22:27:35.598188-07:00", "SourceSystemId": "sample string 3", "CompanyId": "da2b1a91-c1ac-4b8f-9dc9-86b63233b2de", "CreateDate": "2024-10-09T22:27:35.598188-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-09T22:27:35.598188-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-10-09T22:27:35.598188-07:00", "MeasurementValueNeededDate": "2024-10-09T22:27:35.598188-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "dbe4effc-0e76-404f-b430-241173706e01", "CreateDate": "2024-10-09T22:27:35.598188-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-10-09T22:27:35.598188-07:00", "LastModifiedUser": "sample string 8" }, "ValueText": "sample string 1", "PropertyType": { "PropertyTypeId": "2bb52392-8137-41b9-921b-ee04d0091cb5", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "7543c0cc-6d9b-4e44-a6f9-5c2b86046658", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "85ce986f-8361-4ba1-b728-2ade13d911fb", "CreateDate": "2024-10-09T22:27:35.598188-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-10-09T22:27:35.598188-07:00", "LastModifiedUser": "sample string 7" }, "DataType": { "DataTypeId": "a495296e-e7e9-46f8-abc4-ad6fb81efac3", "Name": "sample string 1" }, "Unit": { "UnitId": "e00e607f-e3ce-4d77-88ad-ce111582a038", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "88c5429b-6996-48d3-88b6-4ece31e3f5b9", "CreateDate": "2024-10-09T22:27:35.598188-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-09T22:27:35.598188-07: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": "f680ac74-53e2-4d59-bbce-0cdf2f03109f", "CreateDate": "2024-10-09T22:27:35.598188-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-10-09T22:27:35.598188-07:00", "LastModifiedUser": "sample string 7" }, "IsValid": true, "IsValidMessage": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "bcd88dfb-f995-449f-b184-6043f3898f0f", "CreateDate": "2024-10-09T22:27:35.598188-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-10-09T22:27:35.598188-07:00", "LastModifiedUser": "sample string 7" }, { "PropertyId": "12f85deb-0b96-40e6-8994-a1e63cd3d106", "Asset": { "AssetId": "d8b33cd5-3fef-492d-b22f-26e027be024a", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "7543c0cc-6d9b-4e44-a6f9-5c2b86046658", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "85ce986f-8361-4ba1-b728-2ade13d911fb", "CreateDate": "2024-10-09T22:27:35.598188-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-10-09T22:27:35.598188-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "422154f5-d9ca-4f51-a000-fb1f0389a913", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-10-09T22:27:35.598188-07:00", "MeasurementValueNeededDate": "2024-10-09T22:27:35.598188-07:00", "SourceSystemId": "sample string 3", "CompanyId": "da2b1a91-c1ac-4b8f-9dc9-86b63233b2de", "CreateDate": "2024-10-09T22:27:35.598188-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-09T22:27:35.598188-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-10-09T22:27:35.598188-07:00", "MeasurementValueNeededDate": "2024-10-09T22:27:35.598188-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "dbe4effc-0e76-404f-b430-241173706e01", "CreateDate": "2024-10-09T22:27:35.598188-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-10-09T22:27:35.598188-07:00", "LastModifiedUser": "sample string 8" }, "ValueText": "sample string 1", "PropertyType": { "PropertyTypeId": "2bb52392-8137-41b9-921b-ee04d0091cb5", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "7543c0cc-6d9b-4e44-a6f9-5c2b86046658", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "85ce986f-8361-4ba1-b728-2ade13d911fb", "CreateDate": "2024-10-09T22:27:35.598188-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-10-09T22:27:35.598188-07:00", "LastModifiedUser": "sample string 7" }, "DataType": { "DataTypeId": "a495296e-e7e9-46f8-abc4-ad6fb81efac3", "Name": "sample string 1" }, "Unit": { "UnitId": "e00e607f-e3ce-4d77-88ad-ce111582a038", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "88c5429b-6996-48d3-88b6-4ece31e3f5b9", "CreateDate": "2024-10-09T22:27:35.598188-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-09T22:27:35.598188-07: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": "f680ac74-53e2-4d59-bbce-0cdf2f03109f", "CreateDate": "2024-10-09T22:27:35.598188-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-10-09T22:27:35.598188-07:00", "LastModifiedUser": "sample string 7" }, "IsValid": true, "IsValidMessage": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "bcd88dfb-f995-449f-b184-6043f3898f0f", "CreateDate": "2024-10-09T22:27:35.598188-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-10-09T22:27:35.598188-07:00", "LastModifiedUser": "sample string 7" } ], "Total": 1, "Message": "sample string 1" }