CustomFieldTemplateDto Data Type

The Class CustomFieldTemplateDto.

Implemented Interfaces
Serializable
Properties
name data type constraints description
disabled boolean   Is entity disabled. Value is ignored in Update action - use enable/disable API instead.
id number   The id.
auditableField array of AuditableFieldDto  
code string required The code
description string   The description
languageDescriptions array of LanguageDescriptionDto   The language descriptions.
updatedCode string   The updated code.
fieldType CustomFieldTypeEnum   Value type.
accountLevel string   The account level.
appliesTo string   PROVIDER - Provider, Seller - Seller, Customer - customer, CustomerAccount - Customer account, BillingAccount - Billing Account, UserAccount - User account, Subscription - subscription, Access - access, ChargeTemplate - charge template, ServiceInstance - service instance, ServiceTemplate - service template, OfferTemplateCategory - Offer template category, OfferTemplate - Offer template, JOB_XX - Job instance, CE_ - Custom entity instance.
defaultValue string   Default value.
useInheritedAsDefaultValue boolean   Shall inherited value be used as default value instead if available.
storageType CustomFieldStorageTypeEnum   Value storage type.
valueRequired boolean   Is value required.
uniqueConstraint boolean   Is value is part of unique constraint.
versionable boolean   Is value versionable.
triggerEndPeriodEvent boolean   Should Period end event be fired when value period is over.
calendar string   Calendar associated to value versioning periods.
cacheValueTimeperiod number   How long versionable values be cached past the period end date. As of v.4.7 not used anymore
entityClazz string   Entity class and CET code for a reference to entity or child entity type fields.
listValues map of string   List of values for LIST type field.
allowEdit boolean   Can value be changed when editing a previously saved entity.
hideOnNew boolean   Do not show/apply field on new entity creation.
maxValue number   Maximum value to validate long and double values OR maximum length of string value.
minValue number   Minimum value to validate long and double values.
regExp string   Regular expression to validate string values.
cacheValue boolean   Should value be cached. As of v.4.7 not used anymore
nbDecimal number   The digit's number of a decimal for a double type.
roundingMode RoundingModeEnum   The rounding mode.
guiPosition string   Where field should be displayed. Format: tab:<tab name>:<tab relative position>;fieldGroup:<fieldgroup name>:<fieldgroup relative position>;field:<field relative position in fieldgroup Tab and field group names support translation in the following format: <default value>|<language3 letter key=translated value> e.g. tab:Tab default title|FRA=Title in french|ENG=Title in english:0;fieldGroup:Field group default label|FRA=Field group label in french|ENG=Field group label in english:0;field:0 OR tab:Second tab:1;field:1
mapKeyType CustomFieldMapKeyEnum   Key format of a map for map type fields.
applicableOnEl string   EL expression (including #{}) to evaluate when field is applicable.
matrixColumn array of CustomFieldMatrixColumnDto   A list of columns matrix consists of.
fieldCode array of string   A list of child entity fields to be displayed in a summary table of child entities.
indexType CustomFieldIndexTypeEnum   If and how custom field values should be indexed in Elastic Search.
tags string   Tags assigned to custom field template.
displayFormat string   display format.
customTableCodeEL string   An EL expression that should resolve into the code of a valid CustomTable.
dataFilterEL string   An EL expression that should resolve into a list of filters as defined by the Search API.
fieldsEL string   Should resolve into a list of CT fields to be shown for CTW (displayed in GUI, returned by API). It's the "fields" parameter in the CT list API.
versionFilterEL string   which should resolve into an additional filter to apply to the table search.

Example

{
  "disabled" : true,
  "id" : 12345,
  "auditableField" : [ {
    "entityClass" : "...",
    "fieldName" : "...",
    "id" : 12345,
    "changeOrigin" : "...",
    "auditableField" : [ { }, { } ],
    "originName" : "...",
    "code" : "...",
    "previousState" : "...",
    "currentState" : "...",
    "description" : "...",
    "created" : "...",
    "updatedCode" : "...",
    "actor" : "..."
  }, {
    "entityClass" : "...",
    "fieldName" : "...",
    "id" : 12345,
    "changeOrigin" : "...",
    "auditableField" : [ { }, { } ],
    "originName" : "...",
    "code" : "...",
    "previousState" : "...",
    "currentState" : "...",
    "description" : "...",
    "created" : "...",
    "updatedCode" : "...",
    "actor" : "..."
  } ],
  "code" : "...",
  "description" : "...",
  "languageDescriptions" : [ {
    "languageCode" : "...",
    "description" : "..."
  }, {
    "languageCode" : "...",
    "description" : "..."
  } ],
  "updatedCode" : "...",
  "fieldType" : "TEXT_AREA",
  "appliesTo" : "...",
  "defaultValue" : "...",
  "useInheritedAsDefaultValue" : true,
  "storageType" : "MATRIX",
  "valueRequired" : true,
  "uniqueConstraint" : true,
  "versionable" : true,
  "triggerEndPeriodEvent" : true,
  "calendar" : "...",
  "entityClazz" : "...",
  "listValues" : {
    "property1" : "...",
    "property2" : "..."
  },
  "allowEdit" : true,
  "hideOnNew" : true,
  "maxValue" : 12345,
  "minValue" : 12345,
  "regExp" : "...",
  "nbDecimal" : 12345,
  "roundingMode" : "NEAREST",
  "guiPosition" : "...",
  "mapKeyType" : "STRING",
  "applicableOnEl" : "...",
  "matrixColumn" : [ {
    "columnUse" : "USE_KEY",
    "position" : 12345,
    "code" : "...",
    "label" : "...",
    "keyType" : "RON"
  }, {
    "columnUse" : "USE_VALUE",
    "position" : 12345,
    "code" : "...",
    "label" : "...",
    "keyType" : "STRING"
  } ],
  "fieldCode" : [ "...", "..." ],
  "indexType" : "INDEX",
  "tags" : "...",
  "displayFormat" : "...",
  "customTableCodeEL" : "...",
  "dataFilterEL" : "...",
  "fieldsEL" : "...",
  "versionFilterEL" : "..."
}