customFieldDto Data Type

The Class CustomFieldDto.

Namespace
(Default)
Properties
name data type type namespace min/max occurs wrapped by description
code string attribute 1/1   The code.
description string attribute 1/1   The description.
valueDate dateTime attribute 0/1   The value date.
valuePeriodEndDate dateTime attribute 0/1   The value period end date.
valuePeriodPriority int attribute 0/1   The value period priority.
valuePeriodStartDate dateTime attribute 0/1   The value period start date.
booleanValue boolean element 0/1   The boolean value.
dateValue dateTime element 0/1   The date value.
doubleValue double element 0/1   The double value.
entityReferenceValue entityReferenceDto element 0/1   The entity reference value.
fieldType customFieldTypeEnum element 0/1   The field type.
fileValue string element 0/1   The file value.
formattedValue customFieldFormattedValueDto element 0/1   The formatted value.
guiPosition string element 0/1   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> 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
indexType customFieldIndexTypeEnum element 0/1   The index type.
languageDescriptions languageDescriptionDto element 0/unbounded   The language descriptions.
longValue long element 0/1   The long value.
mapValue (custom) element 0/1   The map value.
stringValue string element 0/1   The string value.
value customFieldValueDto element 0/unbounded listValue The list value.

Example

<CustomField code="..." description="..." valueDate="..." valuePeriodEndDate="..." valuePeriodPriority="..." valuePeriodStartDate="...">
  <fieldType>...</fieldType>
  <languageDescriptions>
    <languageCode>...</languageCode>
    <description>...</description>
  </languageDescriptions>
  <stringValue>...</stringValue>
  <dateValue>...</dateValue>
  <longValue>...</longValue>
  <doubleValue>...</doubleValue>
  <booleanValue>...</booleanValue>
  <listValue>
    <value>
      <dateValue>...</dateValue>
      <doubleValue>...</doubleValue>
      <longValue>...</longValue>
      <stringValue>...</stringValue>
      <entityReferenceValue classname="..." classnameCode="..." code="..."/>
      <childEntityValue cetCode="...">
        <customFields/>
      </childEntityValue>
      <booleanValue>...</booleanValue>
    </value>
  </listValue>
  <mapValue>...</mapValue>
  <entityReferenceValue classname="..." classnameCode="..." code="..."/>
  <indexType>...</indexType>
  <fileValue>...</fileValue>
  <formattedValue code="..." description="..." id="...">
    <singleValue>...</singleValue>
    <listValue>...</listValue>
    <mapValue>...</mapValue>
    <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>
  </formattedValue>
  <guiPosition>...</guiPosition>
</CustomField>