FileFormat Data Type

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

Example

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