FileFormat Data Type

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

Example

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