FileFormat Data Type

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

Example

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