The Class CustomEntityTemplateDto.
| name | data type | constraints | description |
|---|---|---|---|
| disabled | boolean | Is entity disabled. Value is ignored in Update action - use enable/disable API instead. | |
| id | number | The id. | |
| auditableField | array of AuditableFieldDto | ||
| code | string | required | The code |
| name | string | The name | |
| storeAsTable | boolean | Store as a separate table | |
| description | string | The description | |
| storeInES | boolean | Store data in Elastic search | |
| field | array of CustomFieldTemplateDto | The fields. | |
| updatedCode | string | The updated code. | |
| action | array of EntityCustomActionDto | The actions. | |
| disableable | boolean | ||
| versioned | boolean |
Example
{
"disabled" : true,
"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" : "...",
"name" : "...",
"storeAsTable" : true,
"description" : "...",
"storeInES" : true,
"field" : [ {
"disabled" : true,
"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" : "...",
"languageDescriptions" : [ {
"languageCode" : "...",
"description" : "..."
}, {
"languageCode" : "...",
"description" : "..."
} ],
"updatedCode" : "...",
"fieldType" : "LIST",
"appliesTo" : "...",
"defaultValue" : "...",
"useInheritedAsDefaultValue" : true,
"storageType" : "MATRIX",
"valueRequired" : true,
"uniqueConstraint" : true,
"versionable" : true,
"triggerEndPeriodEvent" : true,
"calendar" : "...",
"entityClazz" : "...",
"listValues" : {
"property1" : "...",
"property2" : "..."
},
"allowEdit" : true,
"hideOnNew" : true,
"maxValue" : 12345,
"minValue" : 12345,
"regExp" : "...",
"nbDecimal" : 12345,
"roundingMode" : "NEAREST",
"guiPosition" : "...",
"mapKeyType" : "DOUBLE",
"applicableOnEl" : "...",
"matrixColumn" : [ {
"columnUse" : "USE_VALUE",
"position" : 12345,
"code" : "...",
"label" : "...",
"keyType" : "STRING"
}, {
"columnUse" : "USE_KEY",
"position" : 12345,
"code" : "...",
"label" : "...",
"keyType" : "LONG"
} ],
"fieldCode" : [ "...", "..." ],
"indexType" : "INDEX_NOT_ANALYZE",
"tags" : "...",
"displayFormat" : "...",
"customTableCodeEL" : "...",
"dataFilterEL" : "...",
"fieldsEL" : "...",
"versionFilterEL" : "..."
}, {
"disabled" : true,
"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" : "...",
"languageDescriptions" : [ {
"languageCode" : "...",
"description" : "..."
}, {
"languageCode" : "...",
"description" : "..."
} ],
"updatedCode" : "...",
"fieldType" : "ENTITY",
"appliesTo" : "...",
"defaultValue" : "...",
"useInheritedAsDefaultValue" : true,
"storageType" : "MATRIX",
"valueRequired" : true,
"uniqueConstraint" : true,
"versionable" : true,
"triggerEndPeriodEvent" : true,
"calendar" : "...",
"entityClazz" : "...",
"listValues" : {
"property1" : "...",
"property2" : "..."
},
"allowEdit" : true,
"hideOnNew" : true,
"maxValue" : 12345,
"minValue" : 12345,
"regExp" : "...",
"nbDecimal" : 12345,
"roundingMode" : "NEAREST",
"guiPosition" : "...",
"mapKeyType" : "DOUBLE",
"applicableOnEl" : "...",
"matrixColumn" : [ {
"columnUse" : "USE_KEY",
"position" : 12345,
"code" : "...",
"label" : "...",
"keyType" : "DOUBLE"
}, {
"columnUse" : "USE_VALUE",
"position" : 12345,
"code" : "...",
"label" : "...",
"keyType" : "STRING"
} ],
"fieldCode" : [ "...", "..." ],
"indexType" : "INDEX_NOT_ANALYZE",
"tags" : "...",
"displayFormat" : "...",
"customTableCodeEL" : "...",
"dataFilterEL" : "...",
"fieldsEL" : "...",
"versionFilterEL" : "..."
} ],
"updatedCode" : "...",
"action" : [ {
"disabled" : true,
"appliesTo" : "...",
"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" : "..."
} ],
"applicableOnEl" : "...",
"code" : "...",
"label" : "...",
"labelsTranslated" : [ {
"languageCode" : "...",
"description" : "..."
}, {
"languageCode" : "...",
"description" : "..."
} ],
"description" : "...",
"script" : {
"disabled" : true,
"executionRoles" : [ "...", "..." ],
"type" : "JAVA",
"sourcingRoles" : [ "...", "..." ],
"id" : 12345,
"reuse" : true,
"auditableField" : [ { }, { } ],
"scriptInstanceCategoryCode" : "...",
"script" : "...",
"code" : "...",
"description" : "...",
"updatedCode" : "..."
},
"updatedCode" : "...",
"guiPosition" : "..."
}, {
"disabled" : true,
"appliesTo" : "...",
"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" : "..."
} ],
"applicableOnEl" : "...",
"code" : "...",
"label" : "...",
"labelsTranslated" : [ {
"languageCode" : "...",
"description" : "..."
}, {
"languageCode" : "...",
"description" : "..."
} ],
"description" : "...",
"script" : {
"disabled" : true,
"executionRoles" : [ "...", "..." ],
"type" : "JAVA",
"sourcingRoles" : [ "...", "..." ],
"id" : 12345,
"reuse" : true,
"auditableField" : [ { }, { } ],
"scriptInstanceCategoryCode" : "...",
"script" : "...",
"code" : "...",
"description" : "...",
"updatedCode" : "..."
},
"updatedCode" : "...",
"guiPosition" : "..."
} ],
"disableable" : true,
"versioned" : true
}