| name | data type | constraints | description |
|---|---|---|---|
| referenceDescription | string | ||
| code | string | required, max size: 255, min size: 1 | |
| id | number | ||
| version | number | ||
| parentCFEntities | array of ICustomFieldEntity | ||
| descriptionAndCode | string | ||
| historized | boolean | ||
| transient | boolean | ||
| description | string | max size: 255, min size: 0 | |
| auditable | Auditable | ||
| appendGeneratedCode | boolean | ||
| relativePath | string | ||
| cfValues | CustomFieldValues | ||
| uuid | string | ||
| descriptionOrCode | string | ||
| cfAccumulatedValues | CustomFieldValues | ||
| auditableFields | array of AuditableFieldHistory | ||
| parentEntity | BusinessEntity | ||
| referenceCode | string | ||
| codeChanged | boolean | ||
| parentEntityType | object | ||
| notified | boolean |
Example
{
"referenceDescription" : "...",
"code" : "...",
"id" : 12345,
"version" : 12345,
"parentCFEntities" : [ {
"parentCFEntities" : [ { }, { } ],
"dirtyCF" : true,
"cfValuesAsValues" : {
"property1" : { },
"property2" : { }
},
"cfAccumulatedValues" : {
"valuesByCode" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"values" : {
"property1" : { },
"property2" : { }
},
"newVersionedCFValuePeriods" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"encrypted" : true
},
"cfValuesNullSafe" : {
"valuesByCode" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"values" : {
"property1" : { },
"property2" : { }
},
"newVersionedCFValuePeriods" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"encrypted" : true
},
"cfAccumulatedValuesNullSafe" : {
"valuesByCode" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"values" : {
"property1" : { },
"property2" : { }
},
"newVersionedCFValuePeriods" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"encrypted" : true
},
"cfValues" : {
"valuesByCode" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"values" : {
"property1" : { },
"property2" : { }
},
"newVersionedCFValuePeriods" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"encrypted" : true
},
"CFValuesCopy" : {
"valuesByCode" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"values" : {
"property1" : { },
"property2" : { }
},
"newVersionedCFValuePeriods" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"encrypted" : true
},
"uuid" : "..."
}, {
"parentCFEntities" : [ { }, { } ],
"dirtyCF" : true,
"cfValuesAsValues" : {
"property1" : { },
"property2" : { }
},
"cfAccumulatedValues" : {
"valuesByCode" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"values" : {
"property1" : { },
"property2" : { }
},
"newVersionedCFValuePeriods" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"encrypted" : true
},
"cfValuesNullSafe" : {
"valuesByCode" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"values" : {
"property1" : { },
"property2" : { }
},
"newVersionedCFValuePeriods" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"encrypted" : true
},
"cfAccumulatedValuesNullSafe" : {
"valuesByCode" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"values" : {
"property1" : { },
"property2" : { }
},
"newVersionedCFValuePeriods" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"encrypted" : true
},
"cfValues" : {
"valuesByCode" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"values" : {
"property1" : { },
"property2" : { }
},
"newVersionedCFValuePeriods" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"encrypted" : true
},
"CFValuesCopy" : {
"valuesByCode" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"values" : {
"property1" : { },
"property2" : { }
},
"newVersionedCFValuePeriods" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"encrypted" : true
},
"uuid" : "..."
} ],
"descriptionAndCode" : "...",
"historized" : true,
"transient" : true,
"description" : "...",
"auditable" : {
"lastModified" : 12345,
"updated" : 12345,
"updater" : "...",
"created" : 12345,
"creator" : "...",
"lastUser" : "..."
},
"appendGeneratedCode" : true,
"relativePath" : "...",
"cfValues" : {
"valuesByCode" : {
"property1" : [ {
"from" : 12345,
"to" : 12345,
"string" : "...",
"date" : { },
"long" : 12345,
"double" : 12345.0,
"boolean" : true,
"entity" : { },
"url" : { },
"listString" : [ "...", "..." ],
"listDate" : [ { }, { } ],
"listLong" : [ 12345, 12345 ],
"valid" : true,
"listDouble" : [ 12345.0, 12345.0 ],
"listBoolean" : [ true, true ],
"listEntity" : [ { }, { } ],
"mapString" : {
"property1" : "...",
"property2" : "..."
},
"mapDate" : {
"property1" : 12345,
"property2" : 12345
},
"mapLong" : {
"property1" : 12345,
"property2" : 12345
},
"mapDouble" : {
"property1" : 12345.0,
"property2" : 12345.0
},
"mapBoolean" : {
"property1" : true,
"property2" : true
},
"mapEntity" : {
"property1" : { },
"property2" : { }
},
"source" : "...",
"empty" : true,
"strictMatch" : true,
"fromMatch" : 12345,
"toMatch" : 12345,
"customTableCode" : "...",
"dataFilter" : "...",
"fields" : "...",
"mapCfValues" : {
"property1" : "...",
"property2" : "..."
},
"newPeriod" : true,
"mapValuesForGUI" : [ {
"property1" : { },
"property2" : { }
}, {
"property1" : { },
"property2" : { }
} ],
"matrixValuesForGUI" : [ {
"property1" : { },
"property2" : { }
}, {
"property1" : { },
"property2" : { }
} ],
"listValue" : [ { }, { } ],
"mapValue" : {
"property1" : { },
"property2" : { }
},
"entityReferenceValueForGUI" : { },
"childEntityValuesForGUI" : [ { }, { } ],
"priority" : 12345,
"datasetForGUI" : { },
"valueEmptyForGui" : true,
"valueEmpty" : true,
"value" : { },
"keyValueMap" : {
"property1" : { },
"property2" : { }
},
"excessiveInSize" : true,
"allEntities" : [ { }, { } ]
}, {
"from" : 12345,
"to" : 12345,
"string" : "...",
"date" : { },
"long" : 12345,
"double" : 12345.0,
"boolean" : true,
"entity" : { },
"url" : { },
"listString" : [ "...", "..." ],
"listDate" : [ { }, { } ],
"listLong" : [ 12345, 12345 ],
"valid" : true,
"listDouble" : [ 12345.0, 12345.0 ],
"listBoolean" : [ true, true ],
"listEntity" : [ { }, { } ],
"mapString" : {
"property1" : "...",
"property2" : "..."
},
"mapDate" : {
"property1" : 12345,
"property2" : 12345
},
"mapLong" : {
"property1" : 12345,
"property2" : 12345
},
"mapDouble" : {
"property1" : 12345.0,
"property2" : 12345.0
},
"mapBoolean" : {
"property1" : true,
"property2" : true
},
"mapEntity" : {
"property1" : { },
"property2" : { }
},
"source" : "...",
"empty" : true,
"strictMatch" : true,
"fromMatch" : 12345,
"toMatch" : 12345,
"customTableCode" : "...",
"dataFilter" : "...",
"fields" : "...",
"mapCfValues" : {
"property1" : "...",
"property2" : "..."
},
"newPeriod" : true,
"mapValuesForGUI" : [ {
"property1" : { },
"property2" : { }
}, {
"property1" : { },
"property2" : { }
} ],
"matrixValuesForGUI" : [ {
"property1" : { },
"property2" : { }
}, {
"property1" : { },
"property2" : { }
} ],
"listValue" : [ { }, { } ],
"mapValue" : {
"property1" : { },
"property2" : { }
},
"entityReferenceValueForGUI" : { },
"childEntityValuesForGUI" : [ { }, { } ],
"priority" : 12345,
"datasetForGUI" : { },
"valueEmptyForGui" : true,
"valueEmpty" : true,
"value" : { },
"keyValueMap" : {
"property1" : { },
"property2" : { }
},
"excessiveInSize" : true,
"allEntities" : [ { }, { } ]
} ],
"property2" : [ {
"from" : 12345,
"to" : 12345,
"string" : "...",
"date" : { },
"long" : 12345,
"double" : 12345.0,
"boolean" : true,
"entity" : { },
"url" : { },
"listString" : [ "...", "..." ],
"listDate" : [ { }, { } ],
"listLong" : [ 12345, 12345 ],
"valid" : true,
"listDouble" : [ 12345.0, 12345.0 ],
"listBoolean" : [ true, true ],
"listEntity" : [ { }, { } ],
"mapString" : {
"property1" : "...",
"property2" : "..."
},
"mapDate" : {
"property1" : 12345,
"property2" : 12345
},
"mapLong" : {
"property1" : 12345,
"property2" : 12345
},
"mapDouble" : {
"property1" : 12345.0,
"property2" : 12345.0
},
"mapBoolean" : {
"property1" : true,
"property2" : true
},
"mapEntity" : {
"property1" : { },
"property2" : { }
},
"source" : "...",
"empty" : true,
"strictMatch" : true,
"fromMatch" : 12345,
"toMatch" : 12345,
"customTableCode" : "...",
"dataFilter" : "...",
"fields" : "...",
"mapCfValues" : {
"property1" : "...",
"property2" : "..."
},
"newPeriod" : true,
"mapValuesForGUI" : [ {
"property1" : { },
"property2" : { }
}, {
"property1" : { },
"property2" : { }
} ],
"matrixValuesForGUI" : [ {
"property1" : { },
"property2" : { }
}, {
"property1" : { },
"property2" : { }
} ],
"listValue" : [ { }, { } ],
"mapValue" : {
"property1" : { },
"property2" : { }
},
"entityReferenceValueForGUI" : { },
"childEntityValuesForGUI" : [ { }, { } ],
"priority" : 12345,
"datasetForGUI" : { },
"valueEmptyForGui" : true,
"valueEmpty" : true,
"value" : { },
"keyValueMap" : {
"property1" : { },
"property2" : { }
},
"excessiveInSize" : true,
"allEntities" : [ { }, { } ]
}, {
"from" : 12345,
"to" : 12345,
"string" : "...",
"date" : { },
"long" : 12345,
"double" : 12345.0,
"boolean" : true,
"entity" : { },
"url" : { },
"listString" : [ "...", "..." ],
"listDate" : [ { }, { } ],
"listLong" : [ 12345, 12345 ],
"valid" : true,
"listDouble" : [ 12345.0, 12345.0 ],
"listBoolean" : [ true, true ],
"listEntity" : [ { }, { } ],
"mapString" : {
"property1" : "...",
"property2" : "..."
},
"mapDate" : {
"property1" : 12345,
"property2" : 12345
},
"mapLong" : {
"property1" : 12345,
"property2" : 12345
},
"mapDouble" : {
"property1" : 12345.0,
"property2" : 12345.0
},
"mapBoolean" : {
"property1" : true,
"property2" : true
},
"mapEntity" : {
"property1" : { },
"property2" : { }
},
"source" : "...",
"empty" : true,
"strictMatch" : true,
"fromMatch" : 12345,
"toMatch" : 12345,
"customTableCode" : "...",
"dataFilter" : "...",
"fields" : "...",
"mapCfValues" : {
"property1" : "...",
"property2" : "..."
},
"newPeriod" : true,
"mapValuesForGUI" : [ {
"property1" : { },
"property2" : { }
}, {
"property1" : { },
"property2" : { }
} ],
"matrixValuesForGUI" : [ {
"property1" : { },
"property2" : { }
}, {
"property1" : { },
"property2" : { }
} ],
"listValue" : [ { }, { } ],
"mapValue" : {
"property1" : { },
"property2" : { }
},
"entityReferenceValueForGUI" : { },
"childEntityValuesForGUI" : [ { }, { } ],
"priority" : 12345,
"datasetForGUI" : { },
"valueEmptyForGui" : true,
"valueEmpty" : true,
"value" : { },
"keyValueMap" : {
"property1" : { },
"property2" : { }
},
"excessiveInSize" : true,
"allEntities" : [ { }, { } ]
} ]
},
"values" : {
"property1" : { },
"property2" : { }
},
"newVersionedCFValuePeriods" : {
"property1" : [ {
"from" : 12345,
"to" : 12345,
"valid" : true,
"empty" : true,
"strictMatch" : true,
"fromMatch" : 12345,
"toMatch" : 12345
}, {
"from" : 12345,
"to" : 12345,
"valid" : true,
"empty" : true,
"strictMatch" : true,
"fromMatch" : 12345,
"toMatch" : 12345
} ],
"property2" : [ {
"from" : 12345,
"to" : 12345,
"valid" : true,
"empty" : true,
"strictMatch" : true,
"fromMatch" : 12345,
"toMatch" : 12345
}, {
"from" : 12345,
"to" : 12345,
"valid" : true,
"empty" : true,
"strictMatch" : true,
"fromMatch" : 12345,
"toMatch" : 12345
} ]
},
"encrypted" : true
},
"uuid" : "...",
"descriptionOrCode" : "...",
"cfAccumulatedValues" : {
"valuesByCode" : {
"property1" : [ {
"from" : 12345,
"to" : 12345,
"string" : "...",
"date" : { },
"long" : 12345,
"double" : 12345.0,
"boolean" : true,
"entity" : { },
"url" : { },
"listString" : [ "...", "..." ],
"listDate" : [ { }, { } ],
"listLong" : [ 12345, 12345 ],
"valid" : true,
"listDouble" : [ 12345.0, 12345.0 ],
"listBoolean" : [ true, true ],
"listEntity" : [ { }, { } ],
"mapString" : {
"property1" : "...",
"property2" : "..."
},
"mapDate" : {
"property1" : 12345,
"property2" : 12345
},
"mapLong" : {
"property1" : 12345,
"property2" : 12345
},
"mapDouble" : {
"property1" : 12345.0,
"property2" : 12345.0
},
"mapBoolean" : {
"property1" : true,
"property2" : true
},
"mapEntity" : {
"property1" : { },
"property2" : { }
},
"source" : "...",
"empty" : true,
"strictMatch" : true,
"fromMatch" : 12345,
"toMatch" : 12345,
"customTableCode" : "...",
"dataFilter" : "...",
"fields" : "...",
"mapCfValues" : {
"property1" : "...",
"property2" : "..."
},
"newPeriod" : true,
"mapValuesForGUI" : [ {
"property1" : { },
"property2" : { }
}, {
"property1" : { },
"property2" : { }
} ],
"matrixValuesForGUI" : [ {
"property1" : { },
"property2" : { }
}, {
"property1" : { },
"property2" : { }
} ],
"listValue" : [ { }, { } ],
"mapValue" : {
"property1" : { },
"property2" : { }
},
"entityReferenceValueForGUI" : { },
"childEntityValuesForGUI" : [ { }, { } ],
"priority" : 12345,
"datasetForGUI" : { },
"valueEmptyForGui" : true,
"valueEmpty" : true,
"value" : { },
"keyValueMap" : {
"property1" : { },
"property2" : { }
},
"excessiveInSize" : true,
"allEntities" : [ { }, { } ]
}, {
"from" : 12345,
"to" : 12345,
"string" : "...",
"date" : { },
"long" : 12345,
"double" : 12345.0,
"boolean" : true,
"entity" : { },
"url" : { },
"listString" : [ "...", "..." ],
"listDate" : [ { }, { } ],
"listLong" : [ 12345, 12345 ],
"valid" : true,
"listDouble" : [ 12345.0, 12345.0 ],
"listBoolean" : [ true, true ],
"listEntity" : [ { }, { } ],
"mapString" : {
"property1" : "...",
"property2" : "..."
},
"mapDate" : {
"property1" : 12345,
"property2" : 12345
},
"mapLong" : {
"property1" : 12345,
"property2" : 12345
},
"mapDouble" : {
"property1" : 12345.0,
"property2" : 12345.0
},
"mapBoolean" : {
"property1" : true,
"property2" : true
},
"mapEntity" : {
"property1" : { },
"property2" : { }
},
"source" : "...",
"empty" : true,
"strictMatch" : true,
"fromMatch" : 12345,
"toMatch" : 12345,
"customTableCode" : "...",
"dataFilter" : "...",
"fields" : "...",
"mapCfValues" : {
"property1" : "...",
"property2" : "..."
},
"newPeriod" : true,
"mapValuesForGUI" : [ {
"property1" : { },
"property2" : { }
}, {
"property1" : { },
"property2" : { }
} ],
"matrixValuesForGUI" : [ {
"property1" : { },
"property2" : { }
}, {
"property1" : { },
"property2" : { }
} ],
"listValue" : [ { }, { } ],
"mapValue" : {
"property1" : { },
"property2" : { }
},
"entityReferenceValueForGUI" : { },
"childEntityValuesForGUI" : [ { }, { } ],
"priority" : 12345,
"datasetForGUI" : { },
"valueEmptyForGui" : true,
"valueEmpty" : true,
"value" : { },
"keyValueMap" : {
"property1" : { },
"property2" : { }
},
"excessiveInSize" : true,
"allEntities" : [ { }, { } ]
} ],
"property2" : [ {
"from" : 12345,
"to" : 12345,
"string" : "...",
"date" : { },
"long" : 12345,
"double" : 12345.0,
"boolean" : true,
"entity" : { },
"url" : { },
"listString" : [ "...", "..." ],
"listDate" : [ { }, { } ],
"listLong" : [ 12345, 12345 ],
"valid" : true,
"listDouble" : [ 12345.0, 12345.0 ],
"listBoolean" : [ true, true ],
"listEntity" : [ { }, { } ],
"mapString" : {
"property1" : "...",
"property2" : "..."
},
"mapDate" : {
"property1" : 12345,
"property2" : 12345
},
"mapLong" : {
"property1" : 12345,
"property2" : 12345
},
"mapDouble" : {
"property1" : 12345.0,
"property2" : 12345.0
},
"mapBoolean" : {
"property1" : true,
"property2" : true
},
"mapEntity" : {
"property1" : { },
"property2" : { }
},
"source" : "...",
"empty" : true,
"strictMatch" : true,
"fromMatch" : 12345,
"toMatch" : 12345,
"customTableCode" : "...",
"dataFilter" : "...",
"fields" : "...",
"mapCfValues" : {
"property1" : "...",
"property2" : "..."
},
"newPeriod" : true,
"mapValuesForGUI" : [ {
"property1" : { },
"property2" : { }
}, {
"property1" : { },
"property2" : { }
} ],
"matrixValuesForGUI" : [ {
"property1" : { },
"property2" : { }
}, {
"property1" : { },
"property2" : { }
} ],
"listValue" : [ { }, { } ],
"mapValue" : {
"property1" : { },
"property2" : { }
},
"entityReferenceValueForGUI" : { },
"childEntityValuesForGUI" : [ { }, { } ],
"priority" : 12345,
"datasetForGUI" : { },
"valueEmptyForGui" : true,
"valueEmpty" : true,
"value" : { },
"keyValueMap" : {
"property1" : { },
"property2" : { }
},
"excessiveInSize" : true,
"allEntities" : [ { }, { } ]
}, {
"from" : 12345,
"to" : 12345,
"string" : "...",
"date" : { },
"long" : 12345,
"double" : 12345.0,
"boolean" : true,
"entity" : { },
"url" : { },
"listString" : [ "...", "..." ],
"listDate" : [ { }, { } ],
"listLong" : [ 12345, 12345 ],
"valid" : true,
"listDouble" : [ 12345.0, 12345.0 ],
"listBoolean" : [ true, true ],
"listEntity" : [ { }, { } ],
"mapString" : {
"property1" : "...",
"property2" : "..."
},
"mapDate" : {
"property1" : 12345,
"property2" : 12345
},
"mapLong" : {
"property1" : 12345,
"property2" : 12345
},
"mapDouble" : {
"property1" : 12345.0,
"property2" : 12345.0
},
"mapBoolean" : {
"property1" : true,
"property2" : true
},
"mapEntity" : {
"property1" : { },
"property2" : { }
},
"source" : "...",
"empty" : true,
"strictMatch" : true,
"fromMatch" : 12345,
"toMatch" : 12345,
"customTableCode" : "...",
"dataFilter" : "...",
"fields" : "...",
"mapCfValues" : {
"property1" : "...",
"property2" : "..."
},
"newPeriod" : true,
"mapValuesForGUI" : [ {
"property1" : { },
"property2" : { }
}, {
"property1" : { },
"property2" : { }
} ],
"matrixValuesForGUI" : [ {
"property1" : { },
"property2" : { }
}, {
"property1" : { },
"property2" : { }
} ],
"listValue" : [ { }, { } ],
"mapValue" : {
"property1" : { },
"property2" : { }
},
"entityReferenceValueForGUI" : { },
"childEntityValuesForGUI" : [ { }, { } ],
"priority" : 12345,
"datasetForGUI" : { },
"valueEmptyForGui" : true,
"valueEmpty" : true,
"value" : { },
"keyValueMap" : {
"property1" : { },
"property2" : { }
},
"excessiveInSize" : true,
"allEntities" : [ { }, { } ]
} ]
},
"values" : {
"property1" : { },
"property2" : { }
},
"newVersionedCFValuePeriods" : {
"property1" : [ {
"from" : 12345,
"to" : 12345,
"valid" : true,
"empty" : true,
"strictMatch" : true,
"fromMatch" : 12345,
"toMatch" : 12345
}, {
"from" : 12345,
"to" : 12345,
"valid" : true,
"empty" : true,
"strictMatch" : true,
"fromMatch" : 12345,
"toMatch" : 12345
} ],
"property2" : [ {
"from" : 12345,
"to" : 12345,
"valid" : true,
"empty" : true,
"strictMatch" : true,
"fromMatch" : 12345,
"toMatch" : 12345
}, {
"from" : 12345,
"to" : 12345,
"valid" : true,
"empty" : true,
"strictMatch" : true,
"fromMatch" : 12345,
"toMatch" : 12345
} ]
},
"encrypted" : true
},
"auditableFields" : [ {
"historized" : true,
"notified" : true,
"auditType" : "OTHER",
"historable" : true,
"fieldName" : "...",
"currentState" : { },
"notfiable" : true,
"previousState" : { }
}, {
"historized" : true,
"notified" : true,
"auditType" : "STATUS",
"historable" : true,
"fieldName" : "...",
"currentState" : { },
"notfiable" : true,
"previousState" : { }
} ],
"parentEntity" : {
"descriptionOrCode" : "...",
"auditableFields" : [ {
"historized" : true,
"notified" : true,
"auditType" : "RENEWAL",
"historable" : true,
"fieldName" : "...",
"currentState" : { },
"notfiable" : true,
"previousState" : { }
}, {
"historized" : true,
"notified" : true,
"auditType" : "STATUS",
"historable" : true,
"fieldName" : "...",
"currentState" : { },
"notfiable" : true,
"previousState" : { }
} ],
"version" : 12345,
"historized" : true,
"appendGeneratedCode" : true,
"auditable" : {
"lastModified" : 12345,
"updated" : 12345,
"updater" : "...",
"created" : 12345,
"creator" : "...",
"lastUser" : "..."
},
"parentEntity" : { },
"parentEntityType" : { },
"description" : "...",
"referenceDescription" : "...",
"codeChanged" : true,
"referenceCode" : "...",
"code" : "...",
"transient" : true,
"descriptionAndCode" : "...",
"id" : 12345,
"notified" : true
},
"referenceCode" : "...",
"codeChanged" : true,
"parentEntityType" : { },
"notified" : true
}