| name | data type | description |
|---|---|---|
| code | string | Field code |
| description | string | Field label |
| fieldType | CustomFieldTypeEnum | Value type |
| |
|
|
| appliesTo | string | PROVIDER - Provider, SELLER - Seller, CUST - customer, CA - Customer account, BA - Billing Account, UA - User account, SUB - subscription, ACC - access, CHARGE - charge template, SERVICE - service template or service instance, OFFER_CATEGORY - Offer template category, OFFER - Offer template, JOB_XX - Job instance, CE_ - Custom entity instance |
| defaultValue | string | Default value |
| storageType | CustomFieldStorageTypeEnum | Value storage type |
| valueRequired | boolean | Is value required |
| 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 |
| 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 |
| guiPosition | string | Where field should be displayed - concatenated information with tab and fieldset information in a format: tab:TAB_NAME:TAB_POSITION;fieldGroup:FIELD_SET_NAME:FIELD_SET_POSITION;field:FIELD_POSITION e.g. tab:First tab:0;fieldGroup:Field set name: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 |
Example
{
"code" : "...",
"description" : "...",
"fieldType" : "ENTITY",
"appliesTo" : "...",
"defaultValue" : "...",
"storageType" : "MATRIX",
"valueRequired" : true,
"versionable" : true,
"triggerEndPeriodEvent" : true,
"calendar" : "...",
"cacheValueTimeperiod" : 12345,
"entityClazz" : "...",
"listValues" : {
"property1" : "...",
"property2" : "..."
},
"allowEdit" : true,
"hideOnNew" : true,
"maxValue" : 12345,
"minValue" : 12345,
"regExp" : "...",
"cacheValue" : true,
"guiPosition" : "...",
"mapKeyType" : "STRING",
"applicableOnEl" : "...",
"matrixColumn" : [ {
"position" : 12345,
"code" : "...",
"label" : "...",
"keyType" : "STRING"
}, {
"position" : 12345,
"code" : "...",
"label" : "...",
"keyType" : "STRING"
} ],
"fieldCode" : [ "...", "..." ],
"indexType" : "STORE_ONLY",
"tags" : "..."
}