| name | data type | constraints | description |
|---|---|---|---|
| fileNamePattern | string | ||
| fileTypes | array of FileType | ||
| descriptionOrCode | string | ||
| appendGeneratedCode | boolean | ||
| jobCode | string | ||
| historized | boolean | ||
| version | number | ||
| referenceCode | string | ||
| descriptionAndCode | string | ||
| inputDirectory | string | ||
| referenceDescription | string | ||
| rejectDirectory | string | ||
| description | string | max size: 255, min size: 0 | |
| code | string | required, max size: 255, min size: 1 | |
| auditableFields | array of AuditableFieldHistory | ||
| id | number | ||
| notified | boolean | ||
| recordName | string | ||
| parentEntityType | object | ||
| codeChanged | boolean | ||
| transient | boolean | ||
| configurationTemplate | string | ||
| parentEntity | BusinessEntity | ||
| outputDirectory | string | ||
| archiveDirectory | string | ||
| fileNameUniqueness | boolean | ||
| auditable | Auditable |
Example
{
"fileNamePattern" : "...",
"fileTypes" : [ {
"referenceDescription" : "...",
"codeChanged" : true,
"appendGeneratedCode" : true,
"notified" : true,
"description" : "...",
"descriptionAndCode" : "...",
"parentEntityType" : { },
"auditable" : {
"updater" : "...",
"created" : 12345,
"lastModified" : 12345,
"updated" : 12345,
"lastUser" : "...",
"creator" : "..."
},
"version" : 12345,
"transient" : true,
"parentEntity" : {
"codeChanged" : true,
"historized" : true,
"referenceCode" : "...",
"description" : "...",
"auditable" : { },
"referenceDescription" : "...",
"auditableFields" : [ { }, { } ],
"appendGeneratedCode" : true,
"notified" : true,
"code" : "...",
"parentEntity" : { },
"descriptionAndCode" : "...",
"version" : 12345,
"transient" : true,
"parentEntityType" : { },
"descriptionOrCode" : "...",
"id" : 12345
},
"historized" : true,
"id" : 12345,
"descriptionOrCode" : "...",
"code" : "...",
"referenceCode" : "...",
"auditableFields" : [ {
"previousState" : { },
"currentState" : { },
"auditType" : "STATUS",
"historized" : true,
"fieldName" : "...",
"notified" : true,
"notfiable" : true,
"historable" : true
}, {
"previousState" : { },
"currentState" : { },
"auditType" : "OTHER",
"historized" : true,
"fieldName" : "...",
"notified" : true,
"notfiable" : true,
"historable" : true
} ]
}, {
"referenceDescription" : "...",
"codeChanged" : true,
"appendGeneratedCode" : true,
"notified" : true,
"description" : "...",
"descriptionAndCode" : "...",
"parentEntityType" : { },
"auditable" : {
"updater" : "...",
"created" : 12345,
"lastModified" : 12345,
"updated" : 12345,
"lastUser" : "...",
"creator" : "..."
},
"version" : 12345,
"transient" : true,
"parentEntity" : {
"codeChanged" : true,
"historized" : true,
"referenceCode" : "...",
"description" : "...",
"auditable" : { },
"referenceDescription" : "...",
"auditableFields" : [ { }, { } ],
"appendGeneratedCode" : true,
"notified" : true,
"code" : "...",
"parentEntity" : { },
"descriptionAndCode" : "...",
"version" : 12345,
"transient" : true,
"parentEntityType" : { },
"descriptionOrCode" : "...",
"id" : 12345
},
"historized" : true,
"id" : 12345,
"descriptionOrCode" : "...",
"code" : "...",
"referenceCode" : "...",
"auditableFields" : [ {
"previousState" : { },
"currentState" : { },
"auditType" : "RENEWAL",
"historized" : true,
"fieldName" : "...",
"notified" : true,
"notfiable" : true,
"historable" : true
}, {
"previousState" : { },
"currentState" : { },
"auditType" : "OTHER",
"historized" : true,
"fieldName" : "...",
"notified" : true,
"notfiable" : true,
"historable" : true
} ]
} ],
"descriptionOrCode" : "...",
"appendGeneratedCode" : true,
"jobCode" : "...",
"historized" : true,
"version" : 12345,
"referenceCode" : "...",
"descriptionAndCode" : "...",
"inputDirectory" : "...",
"referenceDescription" : "...",
"rejectDirectory" : "...",
"description" : "...",
"code" : "...",
"auditableFields" : [ {
"previousState" : { },
"currentState" : { },
"auditType" : "OTHER",
"historized" : true,
"fieldName" : "...",
"notified" : true,
"notfiable" : true,
"historable" : true
}, {
"previousState" : { },
"currentState" : { },
"auditType" : "STATUS",
"historized" : true,
"fieldName" : "...",
"notified" : true,
"notfiable" : true,
"historable" : true
} ],
"id" : 12345,
"notified" : true,
"recordName" : "...",
"parentEntityType" : { },
"codeChanged" : true,
"transient" : true,
"configurationTemplate" : "...",
"parentEntity" : {
"codeChanged" : true,
"historized" : true,
"referenceCode" : "...",
"description" : "...",
"auditable" : {
"updater" : "...",
"created" : 12345,
"lastModified" : 12345,
"updated" : 12345,
"lastUser" : "...",
"creator" : "..."
},
"referenceDescription" : "...",
"auditableFields" : [ {
"previousState" : { },
"currentState" : { },
"auditType" : "STATUS",
"historized" : true,
"fieldName" : "...",
"notified" : true,
"notfiable" : true,
"historable" : true
}, {
"previousState" : { },
"currentState" : { },
"auditType" : "OTHER",
"historized" : true,
"fieldName" : "...",
"notified" : true,
"notfiable" : true,
"historable" : true
} ],
"appendGeneratedCode" : true,
"notified" : true,
"code" : "...",
"parentEntity" : { },
"descriptionAndCode" : "...",
"version" : 12345,
"transient" : true,
"parentEntityType" : { },
"descriptionOrCode" : "...",
"id" : 12345
},
"outputDirectory" : "...",
"archiveDirectory" : "...",
"fileNameUniqueness" : true,
"auditable" : {
"updater" : "...",
"created" : 12345,
"lastModified" : 12345,
"updated" : 12345,
"lastUser" : "...",
"creator" : "..."
}
}