LookupFieldMetaDataDTO

A DTO that represents lookup field meta data.

Sub Type Property: "_type" : "LOOKUP_FIELD"

Fields

Type
Name
Description
Optional
Default Value
String  
lookupEntity
The target entity of the lookup.
false
 
String  
lookupRelation
The relation of the lookup field.
false
 
Boolean  
picklist
true if this is a picklist field, otherwise false.
false
 
Boolean  
emptyKeyAllowed
true if this field accepts the empty key, otherwise false.
false
 
Boolean  
numericLookup
true if it is a numeric lookup, otherwise false.
false
 
Boolean  
integerInputOnly
true if only integer values are accepted as input.
false
 
Boolean  
keyFieldVisible
true if the key field is visible, otherwise false.
false
 
Boolean  
keyFieldInListVisible
true if the key field is visible in lists, otherwise false.
false
 
Boolean  
descriptionFieldVisible
true if the description field is visible, otherwise false.
false
 
Boolean  
descriptionFieldInListVisible
true if the description field is visible in lists, otherwise false.
false
 
Boolean  
largeKeyField
true if key field should be displayed as large key field, otherwise false.
false
 
Boolean  
displayLookupSymbol
true if the lookup symbol should be displayed, otherwise false.
false
 
Boolean  
displayLookupSymbolInList
true if the lookup symbol should be displayed in lists, otherwise false.
false
 
LookupDisplayType  
lookupDisplayType
true if the lookup symbol should be displayed in lists, otherwise false.
false
 
String  
id
The field name.
false
 
String  
displayName
The display name of the field.
false
 
Boolean  
visible
true if field is visible, otherwise false.
false
 
Boolean  
readable
true if field is readable, otherwise false.
false
 
Boolean  
readOnly
true if field is read only, otherwise false.
false
 
Boolean  
readOnlyApp
true if field is read only for apps, otherwise false.
false
 
Boolean  
required
true if field is required, otherwise false.
false
 
Boolean  
dataQuality
true if field is relevant for data quality, otherwise false.
false
 
Boolean  
calculated
true if field value is calculated (non-persistent), otherwise false.
false
 
Boolean  
confidential
true if field value is confidential, otherwise false.
false
 
Boolean  
writeOnce
true if field is editable during creation only, otherwise false.
false
 
Boolean  
useUpperCase
true if field accepts upper case characters only, otherwise false.
false
 
Boolean  
unique
true if field value has to be unique, otherwise false.
false
 
Boolean  
uniqueWarning
true if user should be warned on duplate field values, otherwise false.
false
 
Integer  
horizontalAlignment
The horizontal text alignment (10 = left, 0 = center, 11 = right).
false
 
Integer  
maxLength
The maximum input lenght.
false
 
String  
inputMask
The regular expression used as input mask.
false
 
String  
inputMaskError
The error message displayed when violating input mask.
false
 
String  
inputMaskExample
The input example displayed when violating input mask.
false
 

Example

{
	"id": "<FieldName>.<EntitName>",
	"displayName": "<i18nFieldName>",
	"visible": true,
	"readable": true,
	"readOnly": false,
	"required": false,
	"lookupEntity": "Employee",
	"lookupRelation": "rDelegatedTo_Activity",
	"picklist": false,
	"emptyKeyAllowed": true,
	"numericLookup": false,
	"integerInputOnly": false,
	"keyFieldVisible": true,
	"keyFieldInListVisible": true,
	"descriptionFieldVisible": true,
	"descriptionFieldInListVisible": false,
	"largeKeyField": false,
	"displayLookupSymbol": true,
	"displayLookupSymbolInList": false,
	"lookupDisplayType": "DESCRIPTION"
}