FileFormat Data Type

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

Example

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