GET v2/Assets/CustomFields

Retrieves the list of all custom fields defined for assets by the requesting customer.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Lhp.EquipmentIntelligence.WebApi.Client.Models.AssetCustomFieldDefinition

Name	Description	Type	Additional information
AssetCustomFieldDefinitionId	Unique ID for this custom field definition.	integer	None.
CustomerId	ID of the customer that defined this field.	integer	None.
TargetType	Assets that this custom field may be applied to.	Lhp.EquipmentIntelligence.WebApi.Client.Models.AssetCustomFieldDefinition+TargetTypes	None.
RecordId	For the given target type, the ID of the record describing the assets this field may be applied to.	integer	None.
ValueType	Type of the value assigned to instances of this field.	Lhp.EquipmentIntelligence.WebApi.Client.Models.AssetCustomFieldDefinition+ValueTypes	None.
Name	Name of the custom field.	string	None.
Description	Description of the custom field.	string	None.
LookupList	List of options for selection.	Collection of string	None.
IsRequired	Indicates if a value for this field is required for assets that the field applies to.	boolean	None.
IsGlobal	When true, the field owner is an ancestor of a fleet owning customer. This allows a reseller to define a field that can be used by all their OEM customers. The field's value can only be set by the asset's originator.	boolean	None.
IsPrivate	When true, the field's value can only be viewed by the asset's originator. When false, the field's value can be viewed by any asset owner	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "AssetCustomFieldDefinitionId": 1,
    "CustomerId": 2,
    "TargetType": 0,
    "RecordId": 3,
    "ValueType": 0,
    "Name": "sample string 4",
    "Description": "sample string 5",
    "LookupList": [
      "sample string 1",
      "sample string 2"
    ],
    "IsRequired": true,
    "IsGlobal": true,
    "IsPrivate": true
  },
  {
    "AssetCustomFieldDefinitionId": 1,
    "CustomerId": 2,
    "TargetType": 0,
    "RecordId": 3,
    "ValueType": 0,
    "Name": "sample string 4",
    "Description": "sample string 5",
    "LookupList": [
      "sample string 1",
      "sample string 2"
    ],
    "IsRequired": true,
    "IsGlobal": true,
    "IsPrivate": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfAssetCustomFieldDefinition xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <AssetCustomFieldDefinition>
    <AssetCustomFieldDefinitionId>1</AssetCustomFieldDefinitionId>
    <CustomerId>2</CustomerId>
    <TargetType>None</TargetType>
    <RecordId>3</RecordId>
    <ValueType>None</ValueType>
    <Name>sample string 4</Name>
    <Description>sample string 5</Description>
    <LookupList>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </LookupList>
    <IsRequired>true</IsRequired>
    <IsGlobal>true</IsGlobal>
    <IsPrivate>true</IsPrivate>
  </AssetCustomFieldDefinition>
  <AssetCustomFieldDefinition>
    <AssetCustomFieldDefinitionId>1</AssetCustomFieldDefinitionId>
    <CustomerId>2</CustomerId>
    <TargetType>None</TargetType>
    <RecordId>3</RecordId>
    <ValueType>None</ValueType>
    <Name>sample string 4</Name>
    <Description>sample string 5</Description>
    <LookupList>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </LookupList>
    <IsRequired>true</IsRequired>
    <IsGlobal>true</IsGlobal>
    <IsPrivate>true</IsPrivate>
  </AssetCustomFieldDefinition>
</ArrayOfAssetCustomFieldDefinition>