FileFormat Data Type

Implemented Interfaces
IReferenceEntity, Serializable
Properties
name data type constraints description
fileNameUniqueness boolean  
code string required, max size: 255, min size: 1
descriptionOrCode string  
rejectDirectory string  
description string max size: 255, min size: 0
transient boolean  
codeChanged boolean  
fileNamePattern string  
referenceDescription string  
fileTypes array of FileType  
jobCode string  
notified boolean  
parentEntity BusinessEntity  
outputDirectory string  
appendGeneratedCode boolean  
parentEntityType object  
archiveDirectory string  
inputDirectory string  
version number  
id number  
auditable Auditable  
configurationTemplate string  
auditableFields array of AuditableFieldHistory  
referenceCode string  
historized boolean  
descriptionAndCode string  
recordName string  

Example

{
  "fileNameUniqueness" : true,
  "code" : "...",
  "descriptionOrCode" : "...",
  "rejectDirectory" : "...",
  "description" : "...",
  "transient" : true,
  "codeChanged" : true,
  "fileNamePattern" : "...",
  "referenceDescription" : "...",
  "fileTypes" : [ {
    "notified" : true,
    "appendGeneratedCode" : true,
    "description" : "...",
    "version" : 12345,
    "auditableFields" : [ {
      "notfiable" : true,
      "fieldName" : "...",
      "auditType" : "STATUS",
      "previousState" : { },
      "historable" : true,
      "notified" : true,
      "historized" : true,
      "currentState" : { }
    }, {
      "notfiable" : true,
      "fieldName" : "...",
      "auditType" : "STATUS",
      "previousState" : { },
      "historable" : true,
      "notified" : true,
      "historized" : true,
      "currentState" : { }
    } ],
    "id" : 12345,
    "descriptionAndCode" : "...",
    "parentEntityType" : { },
    "auditable" : {
      "creator" : "...",
      "updater" : "...",
      "updated" : 12345,
      "lastModified" : 12345,
      "lastUser" : "...",
      "created" : 12345
    },
    "codeChanged" : true,
    "referenceCode" : "...",
    "historized" : true,
    "referenceDescription" : "...",
    "descriptionOrCode" : "...",
    "code" : "...",
    "transient" : true,
    "parentEntity" : {
      "codeChanged" : true,
      "notified" : true,
      "descriptionOrCode" : "...",
      "description" : "...",
      "version" : 12345,
      "historized" : true,
      "transient" : true,
      "id" : 12345,
      "parentEntityType" : { },
      "parentEntity" : { },
      "referenceCode" : "...",
      "code" : "...",
      "auditableFields" : [ { }, { } ],
      "auditable" : { },
      "descriptionAndCode" : "...",
      "appendGeneratedCode" : true,
      "referenceDescription" : "..."
    }
  }, {
    "notified" : true,
    "appendGeneratedCode" : true,
    "description" : "...",
    "version" : 12345,
    "auditableFields" : [ {
      "notfiable" : true,
      "fieldName" : "...",
      "auditType" : "OTHER",
      "previousState" : { },
      "historable" : true,
      "notified" : true,
      "historized" : true,
      "currentState" : { }
    }, {
      "notfiable" : true,
      "fieldName" : "...",
      "auditType" : "STATUS",
      "previousState" : { },
      "historable" : true,
      "notified" : true,
      "historized" : true,
      "currentState" : { }
    } ],
    "id" : 12345,
    "descriptionAndCode" : "...",
    "parentEntityType" : { },
    "auditable" : {
      "creator" : "...",
      "updater" : "...",
      "updated" : 12345,
      "lastModified" : 12345,
      "lastUser" : "...",
      "created" : 12345
    },
    "codeChanged" : true,
    "referenceCode" : "...",
    "historized" : true,
    "referenceDescription" : "...",
    "descriptionOrCode" : "...",
    "code" : "...",
    "transient" : true,
    "parentEntity" : {
      "codeChanged" : true,
      "notified" : true,
      "descriptionOrCode" : "...",
      "description" : "...",
      "version" : 12345,
      "historized" : true,
      "transient" : true,
      "id" : 12345,
      "parentEntityType" : { },
      "parentEntity" : { },
      "referenceCode" : "...",
      "code" : "...",
      "auditableFields" : [ { }, { } ],
      "auditable" : { },
      "descriptionAndCode" : "...",
      "appendGeneratedCode" : true,
      "referenceDescription" : "..."
    }
  } ],
  "jobCode" : "...",
  "notified" : true,
  "parentEntity" : {
    "codeChanged" : true,
    "notified" : true,
    "descriptionOrCode" : "...",
    "description" : "...",
    "version" : 12345,
    "historized" : true,
    "transient" : true,
    "id" : 12345,
    "parentEntityType" : { },
    "parentEntity" : { },
    "referenceCode" : "...",
    "code" : "...",
    "auditableFields" : [ {
      "notfiable" : true,
      "fieldName" : "...",
      "auditType" : "OTHER",
      "previousState" : { },
      "historable" : true,
      "notified" : true,
      "historized" : true,
      "currentState" : { }
    }, {
      "notfiable" : true,
      "fieldName" : "...",
      "auditType" : "RENEWAL",
      "previousState" : { },
      "historable" : true,
      "notified" : true,
      "historized" : true,
      "currentState" : { }
    } ],
    "auditable" : {
      "creator" : "...",
      "updater" : "...",
      "updated" : 12345,
      "lastModified" : 12345,
      "lastUser" : "...",
      "created" : 12345
    },
    "descriptionAndCode" : "...",
    "appendGeneratedCode" : true,
    "referenceDescription" : "..."
  },
  "outputDirectory" : "...",
  "appendGeneratedCode" : true,
  "parentEntityType" : { },
  "archiveDirectory" : "...",
  "inputDirectory" : "...",
  "version" : 12345,
  "id" : 12345,
  "auditable" : {
    "creator" : "...",
    "updater" : "...",
    "updated" : 12345,
    "lastModified" : 12345,
    "lastUser" : "...",
    "created" : 12345
  },
  "configurationTemplate" : "...",
  "auditableFields" : [ {
    "notfiable" : true,
    "fieldName" : "...",
    "auditType" : "OTHER",
    "previousState" : { },
    "historable" : true,
    "notified" : true,
    "historized" : true,
    "currentState" : { }
  }, {
    "notfiable" : true,
    "fieldName" : "...",
    "auditType" : "RENEWAL",
    "previousState" : { },
    "historable" : true,
    "notified" : true,
    "historized" : true,
    "currentState" : { }
  } ],
  "referenceCode" : "...",
  "historized" : true,
  "descriptionAndCode" : "...",
  "recordName" : "..."
}