GET v2/DataPointValues/Current
Retrieves the current value for the list of requested data points.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
SortBy |
Gets or sets the name of the field to sort by. |
Lhp.EquipmentIntelligence.WebApi.Models.V2.DataPointValueSortFields |
None. |
SortOrder |
Gets or sets the sort order. |
Lhp.EquipmentIntelligence.WebApi.Models.SortOrders |
None. |
Fleet |
When true, returns the entire fleet regardless of whether or not it has a value for the requested datapoint(s) |
boolean |
None. |
DataPointIds |
List of data point values to retrieve. |
Collection of integer |
None. |
SearchSubCustomers |
When true, will return assets from the current user's customer as well as all sub-customers. |
boolean |
None. |
AssetId |
When non-null, return only the matching Asset, if it exists. |
integer |
None. |
VIN |
When neither null or an empty string, return only values for the asset with matching VIN, if it exists. |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of Lhp.EquipmentIntelligence.WebApi.Client.Models.AssetDataPointReportName | Description | Type | Additional information |
---|---|---|---|
AssetId |
Asset ID of the asset. |
integer |
None. |
VIN |
The VIN of the asset. |
string |
None. |
DataPointValues |
The requested data point values. |
Collection of Lhp.EquipmentIntelligence.WebApi.Client.Models.DataPointValue |
None. |
Response Formats
application/json, text/json
Sample:
[ { "AssetId": 1, "VIN": "sample string 2", "DataPointValues": [ { "DataPointId": 1, "Value": "sample string 2", "Timestamp": "2024-09-07T17:51:47.1724579+00:00" }, { "DataPointId": 1, "Value": "sample string 2", "Timestamp": "2024-09-07T17:51:47.1724579+00:00" } ] }, { "AssetId": 1, "VIN": "sample string 2", "DataPointValues": [ { "DataPointId": 1, "Value": "sample string 2", "Timestamp": "2024-09-07T17:51:47.1724579+00:00" }, { "DataPointId": 1, "Value": "sample string 2", "Timestamp": "2024-09-07T17:51:47.1724579+00:00" } ] } ]
application/xml, text/xml
Sample:
<ArrayOfAssetDataPointReport xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <AssetDataPointReport> <AssetId>1</AssetId> <VIN>sample string 2</VIN> <DataPointValues> <DataPointValue> <DataPointId>1</DataPointId> <Value>sample string 2</Value> <Timestamp>2024-09-07T17:51:47.1724579+00:00</Timestamp> </DataPointValue> <DataPointValue> <DataPointId>1</DataPointId> <Value>sample string 2</Value> <Timestamp>2024-09-07T17:51:47.1724579+00:00</Timestamp> </DataPointValue> </DataPointValues> </AssetDataPointReport> <AssetDataPointReport> <AssetId>1</AssetId> <VIN>sample string 2</VIN> <DataPointValues> <DataPointValue> <DataPointId>1</DataPointId> <Value>sample string 2</Value> <Timestamp>2024-09-07T17:51:47.1724579+00:00</Timestamp> </DataPointValue> <DataPointValue> <DataPointId>1</DataPointId> <Value>sample string 2</Value> <Timestamp>2024-09-07T17:51:47.1724579+00:00</Timestamp> </DataPointValue> </DataPointValues> </AssetDataPointReport> </ArrayOfAssetDataPointReport>