ReportExtractDto Data Type

DTO class for ReportExtract entity

Available Since
5.0
Implemented Interfaces
Serializable
Properties
name data type constraints description
disabled boolean   Is entity disabled. Value is ignored in Update action - use enable/disable API instead.
scriptType ReportExtractScriptTypeEnum   The script type.
filenameFormat string   The filename format.
id number   The id.
fileSeparator string   The file separator.
auditableField array of AuditableFieldDto  
category string   The category.
code string required The code
outputDir string   The output directory.
scriptInstanceCode string   The script instance code.
description string   The description
sqlQuery string   The sql query.
params map of string   The params.
startDate number   The start date.
updatedCode string   The updated code.
endDate number   The end date.
reportExtractResultType ReportExtractResultTypeEnum   The type of result that will be generated
style string  
imagePath string  
customTableCode string   Custom table code
accumulate boolean   add new entry or reset the custom table each time
separator string   Field separator by default “;”
decimalSeparator string   Decimal separator by default “.”
generateEmptyReport boolean   Allow empty file Generation
maximumLine number   Maximum line per file, by default 0 (no limit)

Example

{
  "disabled" : true,
  "scriptType" : "JAVA",
  "filenameFormat" : "...",
  "id" : 12345,
  "fileSeparator" : "...",
  "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" : "..."
  } ],
  "category" : "...",
  "code" : "...",
  "outputDir" : "...",
  "scriptInstanceCode" : "...",
  "description" : "...",
  "sqlQuery" : "...",
  "params" : {
    "property1" : "...",
    "property2" : "..."
  },
  "startDate" : 12345,
  "updatedCode" : "...",
  "endDate" : 12345,
  "reportExtractResultType" : "CSV",
  "style" : "...",
  "imagePath" : "...",
  "customTableCode" : "...",
  "accumulate" : true,
  "separator" : "...",
  "decimalSeparator" : "...",
  "generateEmptyReport" : true,
  "maximumLine" : 12345
}