customEntityTemplateDto Data Type

The Class CustomEntityTemplateDto.

Namespace
(Default)
Properties
name data type type namespace min/max occurs wrapped by description
name string attribute 1/1   The name
storeAsTable boolean attribute 0/1   Store as a separate table
action entityCustomActionDto element 0/unbounded actions The actions.
field customFieldTemplateDto element 0/unbounded fields The fields.
Properties inherited from enableBusinessDto
code string attribute 1/1   The code
description string attribute 0/1   The description
id long attribute 0/1   The id.
auditable auditableDto element 0/1    
auditableField auditableFieldDto element 0/unbounded auditableFields  
disabled boolean element 0/1   Is entity disabled. Value is ignored in Update action - use enable/disable API instead.
updatedCode string element 0/1   The updated code.

Example

<CustomEntityTemplate code="..." description="..." id="..." name="..." storeAsTable="...">
  <fields>
    <field code="..." description="..." id="...">
      <languageDescriptions>
        <languageCode>...</languageCode>
        <description>...</description>
      </languageDescriptions>
      <fieldType>...</fieldType>
      <appliesTo>...</appliesTo>
      <defaultValue>...</defaultValue>
      <useInheritedAsDefaultValue>...</useInheritedAsDefaultValue>
      <storageType>...</storageType>
      <valueRequired>...</valueRequired>
      <versionable>...</versionable>
      <triggerEndPeriodEvent>...</triggerEndPeriodEvent>
      <calendar>...</calendar>
      <entityClazz>...</entityClazz>
      <listValues>...</listValues>
      <allowEdit>...</allowEdit>
      <hideOnNew>...</hideOnNew>
      <maxValue>...</maxValue>
      <minValue>...</minValue>
      <regExp>...</regExp>
      <nbDecimal>...</nbDecimal>
      <roundingMode>...</roundingMode>
      <guiPosition>...</guiPosition>
      <mapKeyType>...</mapKeyType>
      <applicableOnEl>...</applicableOnEl>
      <matrixColumns>
        <matrixColumn code="..." columnUse="..." keyType="..." label="..." position="..."/>
      </matrixColumns>
      <childEntityFieldsForSummary>
        <fieldCode>...</fieldCode>
      </childEntityFieldsForSummary>
      <indexType>...</indexType>
      <tags>...</tags>
      <displayFormat>...</displayFormat>
      <disabled>...</disabled>
      <auditable/>
      <auditableFields>
        <auditableField/>
      </auditableFields>
      <updatedCode>...</updatedCode>
    </field>
  </fields>
  <actions>
    <action appliesTo="..." code="..." description="..." id="...">
      <applicableOnEl>...</applicableOnEl>
      <label>...</label>
      <labelsTranslated>
        <languageCode>...</languageCode>
        <description>...</description>
      </labelsTranslated>
      <script>
        <executionRoles/>
        <sourcingRoles/>
        <scriptInstanceCategoryCode>...</scriptInstanceCategoryCode>
      </script>
      <guiPosition>...</guiPosition>
      <disabled>...</disabled>
      <auditable/>
      <auditableFields>
        <auditableField/>
      </auditableFields>
      <updatedCode>...</updatedCode>
    </action>
  </actions>
  <disabled>...</disabled>
  <auditable created="..." creator="..." updated="..." updater="..."/>
  <auditableFields>
    <auditableField actor="..." changeOrigin="..." code="..." created="..." currentState="..." description="..." entityClass="..." fieldName="..." id="..." originName="..." previousState="...">
      <auditable/>
      <auditableFields>
        <auditableField/>
      </auditableFields>
      <updatedCode>...</updatedCode>
    </auditableField>
  </auditableFields>
  <updatedCode>...</updatedCode>
</CustomEntityTemplate>