CustomFieldTemplate Data Type

Implemented Interfaces
IReferenceEntity, Serializable
Properties
name data type constraints description
descriptionI18nNullSafe map of string  
displayFormat string  
descriptionAndCode string  
transient boolean  
appendGeneratedCode boolean  
referenceDescription string  
roundingMode RoundingModeEnum  
description string max size: 255, min size: 0
matrixColumnCodes array of string  
referenceCode string  
matrixValueColumns array of CustomFieldMatrixColumn  
dbFieldname string  
descriptionI18n map of string  
hideInGUI boolean  
triggerEndPeriodEvent boolean  
parentEntity BusinessEntity  
valueRequired boolean  
version number  
childEntityFieldsAsList array of string  
notified boolean  
maxValue number  
useInheritedAsDefaultValue boolean  
codeChanged boolean  
GUIFieldPosition number  
active boolean  
matrixColumns array of CustomFieldMatrixColumn  
applicableOnEl string  
uniqueConstraint boolean  
hideOnNew boolean  
childEntityFields string  
parentEntityType object  
entityClazz string  
guiPositionParsed map of string  
regExp string  
anonymizeGdpr boolean  
allowEdit boolean  
matrixKeyColumns array of CustomFieldMatrixColumn  
nbDecimal number  
indexType CustomFieldIndexTypeEnum  
fieldsEL string  
listValuesSorted map of string  
versionable boolean  
customTableCodeEL string  
historized boolean  
guiPosition string  
dataFilterEL string  
matrixKeyColumnCodes array of string  
defaultValueConverted object  
calendar Calendar  
appliesTo string  
defaultValue string  
tags string  
code string required, max size: 255, min size: 1
fieldType CustomFieldTypeEnum  
listValues map of string  
mapKeyType CustomFieldMapKeyEnum  
auditableFields array of AuditableFieldHistory  
minValue number  
entityClazzCetCode string  
disabled boolean  
matrixValueColumnCodes array of string  
descriptionOrCode string  
protectable boolean  
id number  
storageType CustomFieldStorageTypeEnum  
auditable Auditable  

Example

{
  "descriptionI18nNullSafe" : {
    "property1" : "...",
    "property2" : "..."
  },
  "displayFormat" : "...",
  "descriptionAndCode" : "...",
  "transient" : true,
  "appendGeneratedCode" : true,
  "referenceDescription" : "...",
  "roundingMode" : "UP",
  "description" : "...",
  "matrixColumnCodes" : [ "...", "..." ],
  "referenceCode" : "...",
  "matrixValueColumns" : [ {
    "columnUse" : "USE_KEY",
    "code" : "...",
    "label" : "...",
    "position" : 12345,
    "columnForKey" : true,
    "keyType" : "DOUBLE"
  }, {
    "columnUse" : "USE_VALUE",
    "code" : "...",
    "label" : "...",
    "position" : 12345,
    "columnForKey" : true,
    "keyType" : "STRING"
  } ],
  "dbFieldname" : "...",
  "descriptionI18n" : {
    "property1" : "...",
    "property2" : "..."
  },
  "hideInGUI" : true,
  "triggerEndPeriodEvent" : true,
  "parentEntity" : {
    "codeChanged" : true,
    "historized" : true,
    "referenceCode" : "...",
    "description" : "...",
    "auditable" : {
      "updater" : "...",
      "created" : 12345,
      "lastModified" : 12345,
      "updated" : 12345,
      "lastUser" : "...",
      "creator" : "..."
    },
    "referenceDescription" : "...",
    "auditableFields" : [ {
      "previousState" : { },
      "currentState" : { },
      "auditType" : "RENEWAL",
      "historized" : true,
      "fieldName" : "...",
      "notified" : true,
      "notfiable" : true,
      "historable" : true
    }, {
      "previousState" : { },
      "currentState" : { },
      "auditType" : "RENEWAL",
      "historized" : true,
      "fieldName" : "...",
      "notified" : true,
      "notfiable" : true,
      "historable" : true
    } ],
    "appendGeneratedCode" : true,
    "notified" : true,
    "code" : "...",
    "parentEntity" : { },
    "descriptionAndCode" : "...",
    "version" : 12345,
    "transient" : true,
    "parentEntityType" : { },
    "descriptionOrCode" : "...",
    "id" : 12345
  },
  "valueRequired" : true,
  "version" : 12345,
  "childEntityFieldsAsList" : [ "...", "..." ],
  "notified" : true,
  "maxValue" : 12345,
  "useInheritedAsDefaultValue" : true,
  "codeChanged" : true,
  "GUIFieldPosition" : 12345,
  "active" : true,
  "matrixColumns" : [ {
    "columnUse" : "USE_KEY",
    "code" : "...",
    "label" : "...",
    "position" : 12345,
    "columnForKey" : true,
    "keyType" : "RON"
  }, {
    "columnUse" : "USE_KEY",
    "code" : "...",
    "label" : "...",
    "position" : 12345,
    "columnForKey" : true,
    "keyType" : "RON"
  } ],
  "applicableOnEl" : "...",
  "uniqueConstraint" : true,
  "hideOnNew" : true,
  "childEntityFields" : "...",
  "parentEntityType" : { },
  "entityClazz" : "...",
  "guiPositionParsed" : {
    "property1" : "...",
    "property2" : "..."
  },
  "regExp" : "...",
  "anonymizeGdpr" : true,
  "allowEdit" : true,
  "matrixKeyColumns" : [ {
    "columnUse" : "USE_VALUE",
    "code" : "...",
    "label" : "...",
    "position" : 12345,
    "columnForKey" : true,
    "keyType" : "LONG"
  }, {
    "columnUse" : "USE_KEY",
    "code" : "...",
    "label" : "...",
    "position" : 12345,
    "columnForKey" : true,
    "keyType" : "RON"
  } ],
  "nbDecimal" : 12345,
  "indexType" : "INDEX_NOT_ANALYZE",
  "fieldsEL" : "...",
  "listValuesSorted" : {
    "property1" : "...",
    "property2" : "..."
  },
  "versionable" : true,
  "customTableCodeEL" : "...",
  "historized" : true,
  "guiPosition" : "...",
  "dataFilterEL" : "...",
  "matrixKeyColumnCodes" : [ "...", "..." ],
  "defaultValueConverted" : { },
  "calendar" : {
    "version" : 12345,
    "transient" : true,
    "initDateEL" : "...",
    "descriptionAndCode" : "...",
    "codeChanged" : true,
    "descriptionI18n" : {
      "property1" : "...",
      "property2" : "..."
    },
    "parentEntity" : {
      "codeChanged" : true,
      "historized" : true,
      "referenceCode" : "...",
      "description" : "...",
      "auditable" : { },
      "referenceDescription" : "...",
      "auditableFields" : [ { }, { } ],
      "appendGeneratedCode" : true,
      "notified" : true,
      "code" : "...",
      "parentEntity" : { },
      "descriptionAndCode" : "...",
      "version" : 12345,
      "transient" : true,
      "parentEntityType" : { },
      "descriptionOrCode" : "...",
      "id" : 12345
    },
    "calendarType" : "...",
    "historized" : true,
    "auditableFields" : [ {
      "previousState" : { },
      "currentState" : { },
      "auditType" : "STATUS",
      "historized" : true,
      "fieldName" : "...",
      "notified" : true,
      "notfiable" : true,
      "historable" : true
    }, {
      "previousState" : { },
      "currentState" : { },
      "auditType" : "RENEWAL",
      "historized" : true,
      "fieldName" : "...",
      "notified" : true,
      "notfiable" : true,
      "historable" : true
    } ],
    "notified" : true,
    "referenceDescription" : "...",
    "auditable" : {
      "updater" : "...",
      "created" : 12345,
      "lastModified" : 12345,
      "updated" : 12345,
      "lastUser" : "...",
      "creator" : "..."
    },
    "initDate" : 12345,
    "id" : 12345,
    "parentEntityType" : { },
    "code" : "...",
    "description" : "...",
    "referenceCode" : "...",
    "appendGeneratedCode" : true,
    "descriptionOrCode" : "...",
    "calendarTypeWSubtypes" : "...",
    "initializationRequired" : true
  },
  "appliesTo" : "...",
  "defaultValue" : "...",
  "tags" : "...",
  "code" : "...",
  "fieldType" : "LONG",
  "listValues" : {
    "property1" : "...",
    "property2" : "..."
  },
  "mapKeyType" : "RON",
  "auditableFields" : [ {
    "previousState" : { },
    "currentState" : { },
    "auditType" : "STATUS",
    "historized" : true,
    "fieldName" : "...",
    "notified" : true,
    "notfiable" : true,
    "historable" : true
  }, {
    "previousState" : { },
    "currentState" : { },
    "auditType" : "OTHER",
    "historized" : true,
    "fieldName" : "...",
    "notified" : true,
    "notfiable" : true,
    "historable" : true
  } ],
  "minValue" : 12345,
  "entityClazzCetCode" : "...",
  "disabled" : true,
  "matrixValueColumnCodes" : [ "...", "..." ],
  "descriptionOrCode" : "...",
  "protectable" : true,
  "id" : 12345,
  "storageType" : "LIST",
  "auditable" : {
    "updater" : "...",
    "created" : 12345,
    "lastModified" : 12345,
    "updated" : 12345,
    "lastUser" : "...",
    "creator" : "..."
  }
}