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": "11735f9c-6004-498f-82ff-224fa866e659", "Asset": { "AssetId": "d4847390-d1ae-4a7c-812b-5bbb870defc7", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "a84fe5b5-3fff-476f-99c0-a5146b9c3638", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "7d708e52-163b-4591-9527-9f72fb889bbb", "CreateDate": "2025-03-18T17:20:23.0789543-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-03-18T17:20:23.0789543-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "36519fd8-3150-4c65-8ba2-3bab7280f9a4", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-03-18T17:20:23.0789543-07:00", "MeasurementValueNeededDate": "2025-03-18T17:20:23.0789543-07:00", "SourceSystemId": "sample string 3", "CompanyId": "128f7161-5ebb-4b77-b350-d97b3cca2a15", "CreateDate": "2025-03-18T17:20:23.0789543-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-03-18T17:20:23.0789543-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-03-18T17:20:23.0789543-07:00", "MeasurementValueNeededDate": "2025-03-18T17:20:23.0789543-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "2e9ace56-a1d4-4564-8704-bd44fc7c736f", "CreateDate": "2025-03-18T17:20:23.0789543-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-03-18T17:20:23.0789543-07:00", "LastModifiedUser": "sample string 8" }, "ValueText": "sample string 1", "PropertyType": { "PropertyTypeId": "20130d73-7fbc-41a1-964c-1ab37e0811f5", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "a84fe5b5-3fff-476f-99c0-a5146b9c3638", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "7d708e52-163b-4591-9527-9f72fb889bbb", "CreateDate": "2025-03-18T17:20:23.0789543-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-03-18T17:20:23.0789543-07:00", "LastModifiedUser": "sample string 7" }, "DataType": { "DataTypeId": "de8d5b10-d53c-4227-8469-0a36a334896f", "Name": "sample string 1" }, "Unit": { "UnitId": "dfe0e1c8-db22-4231-bc71-6fbc160e67fb", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "27696cb6-0534-453e-81c6-1ee4639cb56c", "CreateDate": "2025-03-18T17:20:23.0789543-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-03-18T17:20:23.0789543-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": "4577a68a-984c-4ef8-a9e1-f63aee7e8580", "CreateDate": "2025-03-18T17:20:23.0789543-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-03-18T17:20:23.0789543-07:00", "LastModifiedUser": "sample string 7" }, "IsValid": true, "IsValidMessage": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "076a6e6a-2549-4693-935b-f468b3a60dad", "CreateDate": "2025-03-18T17:20:23.0789543-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-03-18T17:20:23.0789543-07:00", "LastModifiedUser": "sample string 7" }, { "PropertyId": "11735f9c-6004-498f-82ff-224fa866e659", "Asset": { "AssetId": "d4847390-d1ae-4a7c-812b-5bbb870defc7", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "a84fe5b5-3fff-476f-99c0-a5146b9c3638", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "7d708e52-163b-4591-9527-9f72fb889bbb", "CreateDate": "2025-03-18T17:20:23.0789543-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-03-18T17:20:23.0789543-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "36519fd8-3150-4c65-8ba2-3bab7280f9a4", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-03-18T17:20:23.0789543-07:00", "MeasurementValueNeededDate": "2025-03-18T17:20:23.0789543-07:00", "SourceSystemId": "sample string 3", "CompanyId": "128f7161-5ebb-4b77-b350-d97b3cca2a15", "CreateDate": "2025-03-18T17:20:23.0789543-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-03-18T17:20:23.0789543-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-03-18T17:20:23.0789543-07:00", "MeasurementValueNeededDate": "2025-03-18T17:20:23.0789543-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "2e9ace56-a1d4-4564-8704-bd44fc7c736f", "CreateDate": "2025-03-18T17:20:23.0789543-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-03-18T17:20:23.0789543-07:00", "LastModifiedUser": "sample string 8" }, "ValueText": "sample string 1", "PropertyType": { "PropertyTypeId": "20130d73-7fbc-41a1-964c-1ab37e0811f5", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "a84fe5b5-3fff-476f-99c0-a5146b9c3638", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "7d708e52-163b-4591-9527-9f72fb889bbb", "CreateDate": "2025-03-18T17:20:23.0789543-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-03-18T17:20:23.0789543-07:00", "LastModifiedUser": "sample string 7" }, "DataType": { "DataTypeId": "de8d5b10-d53c-4227-8469-0a36a334896f", "Name": "sample string 1" }, "Unit": { "UnitId": "dfe0e1c8-db22-4231-bc71-6fbc160e67fb", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "27696cb6-0534-453e-81c6-1ee4639cb56c", "CreateDate": "2025-03-18T17:20:23.0789543-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-03-18T17:20:23.0789543-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": "4577a68a-984c-4ef8-a9e1-f63aee7e8580", "CreateDate": "2025-03-18T17:20:23.0789543-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-03-18T17:20:23.0789543-07:00", "LastModifiedUser": "sample string 7" }, "IsValid": true, "IsValidMessage": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "076a6e6a-2549-4693-935b-f468b3a60dad", "CreateDate": "2025-03-18T17:20:23.0789543-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-03-18T17:20:23.0789543-07:00", "LastModifiedUser": "sample string 7" } ], "Total": 1, "Message": "sample string 1" }