CustomFieldDto Data Type

The Class CustomFieldDto.

Properties
name data type description
code string The code.
description string The description.
fieldType CustomFieldTypeEnum The field type.
languageDescriptions array of LanguageDescriptionDto The language descriptions.
valueDate number The value date.
valuePeriodStartDate number The value period start date.
valuePeriodEndDate number The value period end date.
valuePeriodPriority number The value period priority.
stringValue string The string value.
dateValue number The date value.
longValue number The long value.
doubleValue number The double value.
booleanValue boolean The boolean value.
value array of CustomFieldValueDto The list value.
mapValue map of CustomFieldValueDto The map value.
entityReferenceValue EntityReferenceDto The entity reference value.
indexType CustomFieldIndexTypeEnum The index type.
fileValue string The file value.
formattedValue CustomFieldFormattedValueDto The formatted value.
urlReferenceValue UrlReferenceDto The Url reference value.
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>

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

customTableCode string Custom Table Code.
dataFilter string Filters for custom table wrapper.
fields string Fields for cutsom table wrapper.

Example

{
  "code" : "...",
  "description" : "...",
  "fieldType" : "CHILD_ENTITY",
  "languageDescriptions" : [ {
    "languageCode" : "...",
    "description" : "..."
  }, {
    "languageCode" : "...",
    "description" : "..."
  } ],
  "valueDate" : 12345,
  "valuePeriodStartDate" : 12345,
  "valuePeriodEndDate" : 12345,
  "valuePeriodPriority" : 12345,
  "stringValue" : "...",
  "dateValue" : 12345,
  "longValue" : 12345,
  "doubleValue" : 12345.0,
  "booleanValue" : true,
  "value" : [ {
    "value" : {
      "booleanValue" : true
    }
  }, {
    "value" : {
      "booleanValue" : true
    }
  } ],
  "mapValue" : {
    "property1" : {
      "value" : {
        "booleanValue" : true
      }
    },
    "property2" : {
      "value" : {
        "booleanValue" : true
      }
    }
  },
  "entityReferenceValue" : {
    "classname" : "...",
    "classnameCode" : "...",
    "code" : "..."
  },
  "indexType" : "INDEX",
  "fileValue" : "...",
  "formattedValue" : {
    "singleValue" : "...",
    "listValue" : [ "...", "..." ],
    "mapValue" : {
      "property1" : "...",
      "property2" : "..."
    },
    "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" : "...",
    "updatedCode" : "..."
  },
  "urlReferenceValue" : {
    "url" : "...",
    "regexp" : "...",
    "label" : "...",
    "length" : 12345
  },
  "guiPosition" : "...",
  "customTableCode" : "...",
  "dataFilter" : "...",
  "fields" : "..."
}