GET v2/CustomFieldValues

Returns custom field values for the requesting user's fleet.

Request Information

URI Parameters

Name	Description	Type	Additional information
AssetStatuses	When provided, will only return assets of the specified statuses. Defaults to Owned\|Sold.	Lhp.EquipmentIntelligence.CustomerAssetStatuses	None.
CustomFieldIds	When provided, will only return the specified custom fields via their primary numeric key	Collection of integer	None.
Keys	When provided, will only return the specified custom fields via their unique key	Collection of string	None.
Value	When provided, will only return values that match. Only applicable when searching by a single CustomFieldId.	string	None.
UpdatedSinceUtc	When provided, will only return values created or updated since this date/time	date	None.

Body Parameters

None.

Response Information

Resource Description

Collection of Lhp.EquipmentIntelligence.WebApi.Models.V2.CustomFieldValue

Name	Description	Type	Additional information
AssetId	The asset ID	integer	None.
AssetVin	The asset VIN	string	None.
TcuId	The TCU ID	integer	None.
TcuImei	The TCU IMEI	string	None.
CustomFieldId	The asset custom field ID	integer	None.
CustomFieldKey	The asset custom field key	string	None.
CustomFieldName	The asset custom field name	string	None.
CustomFieldOwner	The asset custom field owner name	string	None.
Value	The asset custom field value	string	None.
CreatedOn	The date/time the value was created in UTC	date	None.
LastUpdatedOn	The date/time the value was updated in UTC	date	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "AssetId": 1,
    "AssetVin": "sample string 2",
    "TcuId": 1,
    "TcuImei": "sample string 3",
    "CustomFieldId": 4,
    "CustomFieldKey": "sample string 5",
    "CustomFieldName": "sample string 6",
    "CustomFieldOwner": "sample string 7",
    "Value": "sample string 8",
    "CreatedOn": "2024-09-07T17:52:34.4871765+00:00",
    "LastUpdatedOn": "2024-09-07T17:52:34.4871765+00:00"
  },
  {
    "AssetId": 1,
    "AssetVin": "sample string 2",
    "TcuId": 1,
    "TcuImei": "sample string 3",
    "CustomFieldId": 4,
    "CustomFieldKey": "sample string 5",
    "CustomFieldName": "sample string 6",
    "CustomFieldOwner": "sample string 7",
    "Value": "sample string 8",
    "CreatedOn": "2024-09-07T17:52:34.4871765+00:00",
    "LastUpdatedOn": "2024-09-07T17:52:34.4871765+00:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfCustomFieldValue xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CustomFieldValue>
    <AssetId>1</AssetId>
    <AssetVin>sample string 2</AssetVin>
    <TcuId>1</TcuId>
    <TcuImei>sample string 3</TcuImei>
    <CustomFieldId>4</CustomFieldId>
    <CustomFieldKey>sample string 5</CustomFieldKey>
    <CustomFieldName>sample string 6</CustomFieldName>
    <CustomFieldOwner>sample string 7</CustomFieldOwner>
    <Value>sample string 8</Value>
    <CreatedOn>2024-09-07T17:52:34.4871765+00:00</CreatedOn>
    <LastUpdatedOn>2024-09-07T17:52:34.4871765+00:00</LastUpdatedOn>
  </CustomFieldValue>
  <CustomFieldValue>
    <AssetId>1</AssetId>
    <AssetVin>sample string 2</AssetVin>
    <TcuId>1</TcuId>
    <TcuImei>sample string 3</TcuImei>
    <CustomFieldId>4</CustomFieldId>
    <CustomFieldKey>sample string 5</CustomFieldKey>
    <CustomFieldName>sample string 6</CustomFieldName>
    <CustomFieldOwner>sample string 7</CustomFieldOwner>
    <Value>sample string 8</Value>
    <CreatedOn>2024-09-07T17:52:34.4871765+00:00</CreatedOn>
    <LastUpdatedOn>2024-09-07T17:52:34.4871765+00:00</LastUpdatedOn>
  </CustomFieldValue>
</ArrayOfCustomFieldValue>