| name | data type | constraints | description |
|---|---|---|---|
| historized | boolean | ||
| referenceDescription | string | ||
| parentEntityType | object | ||
| parentEntity | BusinessEntity | ||
| fileFormat | string | ||
| reportQuery | ReportQuery | ||
| emailsToNotify | array of string | ||
| descriptionOrCode | string | ||
| isQueryScheduler | boolean | ||
| usersToNotify | array of User | ||
| queryTimer | QueryTimer | ||
| transient | boolean | ||
| referenceCode | string | ||
| auditable | Auditable | ||
| jobInstance | JobInstance | ||
| codeChanged | boolean | ||
| auditableFields | array of AuditableFieldHistory | ||
| id | number | ||
| appendGeneratedCode | boolean | ||
| code | string | required, max size: 255, min size: 1 | |
| description | string | max size: 255, min size: 0 | |
| descriptionAndCode | string | ||
| version | number | ||
| notified | boolean |
Example
{
"historized" : true,
"referenceDescription" : "...",
"parentEntityType" : { },
"parentEntity" : {
"referenceDescription" : "...",
"auditableFields" : [ {
"fieldName" : "...",
"notfiable" : true,
"auditType" : "STATUS",
"historized" : true,
"previousState" : { },
"currentState" : { },
"historable" : true,
"notified" : true
}, {
"fieldName" : "...",
"notfiable" : true,
"auditType" : "RENEWAL",
"historized" : true,
"previousState" : { },
"currentState" : { },
"historable" : true,
"notified" : true
} ],
"parentEntity" : { },
"codeChanged" : true,
"description" : "...",
"auditable" : {
"created" : 12345,
"creator" : "...",
"lastUser" : "...",
"updater" : "...",
"updated" : 12345,
"lastModified" : 12345
},
"transient" : true,
"referenceCode" : "...",
"version" : 12345,
"code" : "...",
"parentEntityType" : { },
"id" : 12345,
"notified" : true,
"appendGeneratedCode" : true,
"descriptionAndCode" : "...",
"historized" : true,
"descriptionOrCode" : "..."
},
"fileFormat" : "...",
"reportQuery" : {
"visibility" : "PUBLIC",
"version" : 12345,
"descriptionOrCode" : "...",
"transient" : true,
"auditableFields" : [ {
"fieldName" : "...",
"notfiable" : true,
"auditType" : "OTHER",
"historized" : true,
"previousState" : { },
"currentState" : { },
"historable" : true,
"notified" : true
}, {
"fieldName" : "...",
"notfiable" : true,
"auditType" : "RENEWAL",
"historized" : true,
"previousState" : { },
"currentState" : { },
"historable" : true,
"notified" : true
} ],
"referenceCode" : "...",
"parentEntityType" : { },
"sortOrder" : "ASCENDING",
"codeChanged" : true,
"filters" : {
"property1" : "...",
"property2" : "..."
},
"sortBy" : "...",
"notified" : true,
"description" : "...",
"referenceDescription" : "...",
"generatedQuery" : "...",
"targetEntity" : "...",
"historized" : true,
"appendGeneratedCode" : true,
"auditable" : {
"created" : 12345,
"creator" : "...",
"lastUser" : "...",
"updater" : "...",
"updated" : 12345,
"lastModified" : 12345
},
"parentEntity" : {
"referenceDescription" : "...",
"auditableFields" : [ { }, { } ],
"parentEntity" : { },
"codeChanged" : true,
"description" : "...",
"auditable" : { },
"transient" : true,
"referenceCode" : "...",
"version" : 12345,
"code" : "...",
"parentEntityType" : { },
"id" : 12345,
"notified" : true,
"appendGeneratedCode" : true,
"descriptionAndCode" : "...",
"historized" : true,
"descriptionOrCode" : "..."
},
"descriptionAndCode" : "...",
"code" : "...",
"id" : 12345,
"fields" : [ "...", "..." ]
},
"emailsToNotify" : [ "...", "..." ],
"descriptionOrCode" : "...",
"isQueryScheduler" : true,
"usersToNotify" : [ {
"userName" : "...",
"auditableFields" : [ {
"fieldName" : "...",
"notfiable" : true,
"auditType" : "OTHER",
"historized" : true,
"previousState" : { },
"currentState" : { },
"historable" : true,
"notified" : true
}, {
"fieldName" : "...",
"notfiable" : true,
"auditType" : "RENEWAL",
"historized" : true,
"previousState" : { },
"currentState" : { },
"historable" : true,
"notified" : true
} ],
"notified" : true,
"nameOrUsername" : "...",
"version" : 12345,
"referenceCode" : "...",
"userLevel" : "...",
"code" : "...",
"cfValues" : {
"valuesByCode" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"values" : {
"property1" : { },
"property2" : { }
},
"newVersionedCFValuePeriods" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"encrypted" : true
},
"name" : {
"fullName" : "...",
"title" : { },
"lastName" : "...",
"firstName" : "..."
},
"referenceDescription" : "...",
"transient" : true,
"uuid" : "...",
"email" : "...",
"cfAccumulatedValues" : {
"valuesByCode" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"values" : {
"property1" : { },
"property2" : { }
},
"newVersionedCFValuePeriods" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"encrypted" : true
},
"description" : "...",
"historized" : true,
"password" : "...",
"roles" : [ "...", "..." ],
"id" : 12345,
"auditable" : {
"created" : 12345,
"creator" : "...",
"lastUser" : "...",
"updater" : "...",
"updated" : 12345,
"lastModified" : 12345
},
"parentCFEntities" : [ {
"cfValuesNullSafe" : { },
"uuid" : "...",
"dirtyCF" : true,
"cfValuesAsValues" : {
"property1" : { },
"property2" : { }
},
"cfValues" : { },
"parentCFEntities" : [ { }, { } ],
"CFValuesCopy" : { },
"cfAccumulatedValuesNullSafe" : { },
"cfAccumulatedValues" : { }
}, {
"cfValuesNullSafe" : { },
"uuid" : "...",
"dirtyCF" : true,
"cfValuesAsValues" : {
"property1" : { },
"property2" : { }
},
"cfValues" : { },
"parentCFEntities" : [ { }, { } ],
"CFValuesCopy" : { },
"cfAccumulatedValuesNullSafe" : { },
"cfAccumulatedValues" : { }
} ]
}, {
"userName" : "...",
"auditableFields" : [ {
"fieldName" : "...",
"notfiable" : true,
"auditType" : "STATUS",
"historized" : true,
"previousState" : { },
"currentState" : { },
"historable" : true,
"notified" : true
}, {
"fieldName" : "...",
"notfiable" : true,
"auditType" : "RENEWAL",
"historized" : true,
"previousState" : { },
"currentState" : { },
"historable" : true,
"notified" : true
} ],
"notified" : true,
"nameOrUsername" : "...",
"version" : 12345,
"referenceCode" : "...",
"userLevel" : "...",
"code" : "...",
"cfValues" : {
"valuesByCode" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"values" : {
"property1" : { },
"property2" : { }
},
"newVersionedCFValuePeriods" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"encrypted" : true
},
"name" : {
"fullName" : "...",
"title" : { },
"lastName" : "...",
"firstName" : "..."
},
"referenceDescription" : "...",
"transient" : true,
"uuid" : "...",
"email" : "...",
"cfAccumulatedValues" : {
"valuesByCode" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"values" : {
"property1" : { },
"property2" : { }
},
"newVersionedCFValuePeriods" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"encrypted" : true
},
"description" : "...",
"historized" : true,
"password" : "...",
"roles" : [ "...", "..." ],
"id" : 12345,
"auditable" : {
"created" : 12345,
"creator" : "...",
"lastUser" : "...",
"updater" : "...",
"updated" : 12345,
"lastModified" : 12345
},
"parentCFEntities" : [ {
"cfValuesNullSafe" : { },
"uuid" : "...",
"dirtyCF" : true,
"cfValuesAsValues" : {
"property1" : { },
"property2" : { }
},
"cfValues" : { },
"parentCFEntities" : [ { }, { } ],
"CFValuesCopy" : { },
"cfAccumulatedValuesNullSafe" : { },
"cfAccumulatedValues" : { }
}, {
"cfValuesNullSafe" : { },
"uuid" : "...",
"dirtyCF" : true,
"cfValuesAsValues" : {
"property1" : { },
"property2" : { }
},
"cfValues" : { },
"parentCFEntities" : [ { }, { } ],
"CFValuesCopy" : { },
"cfAccumulatedValuesNullSafe" : { },
"cfAccumulatedValues" : { }
} ]
} ],
"queryTimer" : {
"dayOfWeek" : "...",
"everyHour" : true,
"everyDayOfMonth" : true,
"everyDayOfWeek" : true,
"everyMonth" : true,
"second" : "...",
"everySecond" : true,
"dayOfMonth" : "...",
"everyMinute" : true,
"month" : "...",
"minute" : "...",
"hour" : "...",
"year" : "..."
},
"transient" : true,
"referenceCode" : "...",
"auditable" : {
"created" : 12345,
"creator" : "...",
"lastUser" : "...",
"updater" : "...",
"updated" : 12345,
"lastModified" : 12345
},
"jobInstance" : {
"executionResults" : [ {
"warnings" : [ "...", "..." ],
"id" : 12345,
"nbItemsProcessedWithError" : 12345,
"jobInstance" : { },
"status" : "CANCELLED",
"nbItemsProcessedWithWarning" : 12345,
"nbItemsProcessed" : 12345,
"startDate" : 12345,
"nbItemsToProcess" : 12345,
"version" : 12345,
"jobLauncherEnum" : "API",
"report" : "...",
"moreToProcess" : true,
"nbItemsCorrectlyProcessed" : 12345,
"errors" : [ "...", "..." ],
"transient" : true,
"endDate" : 12345
}, {
"warnings" : [ "...", "..." ],
"id" : 12345,
"nbItemsProcessedWithError" : 12345,
"jobInstance" : { },
"status" : "RUNNING",
"nbItemsProcessedWithWarning" : 12345,
"nbItemsProcessed" : 12345,
"startDate" : 12345,
"nbItemsToProcess" : 12345,
"version" : 12345,
"jobLauncherEnum" : "TIMER",
"report" : "...",
"moreToProcess" : true,
"nbItemsCorrectlyProcessed" : 12345,
"errors" : [ "...", "..." ],
"transient" : true,
"endDate" : 12345
} ],
"description" : "...",
"auditableFields" : [ {
"fieldName" : "...",
"notfiable" : true,
"auditType" : "RENEWAL",
"historized" : true,
"previousState" : { },
"currentState" : { },
"historable" : true,
"notified" : true
}, {
"fieldName" : "...",
"notfiable" : true,
"auditType" : "RENEWAL",
"historized" : true,
"previousState" : { },
"currentState" : { },
"historable" : true,
"notified" : true
} ],
"referenceCode" : "...",
"transient" : true,
"disabled" : true,
"jobCategoryEnum" : "...",
"jobSpeed" : "VERY_FAST",
"uuid" : "...",
"descriptionOrCode" : "...",
"parametres" : "...",
"cfAccumulatedValues" : {
"valuesByCode" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"values" : {
"property1" : { },
"property2" : { }
},
"newVersionedCFValuePeriods" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"encrypted" : true
},
"active" : true,
"verboseReport" : true,
"notified" : true,
"excludeInvoicesWithoutAmount" : true,
"runTimeParametres" : "...",
"codeChanged" : true,
"timerEntity" : {
"appendGeneratedCode" : true,
"disabled" : true,
"id" : 12345,
"descriptionOrCode" : "...",
"codeChanged" : true,
"active" : true,
"auditableFields" : [ { }, { } ],
"code" : "...",
"minute" : "...",
"parentEntity" : { },
"start" : 12345,
"historized" : true,
"version" : 12345,
"referenceDescription" : "...",
"description" : "...",
"parentEntityType" : { },
"descriptionAndCode" : "...",
"auditable" : { },
"referenceCode" : "...",
"year" : "...",
"transient" : true,
"end" : 12345,
"month" : "...",
"hour" : "...",
"timerSchedule" : "...",
"jobInstances" : [ { }, { } ],
"second" : "...",
"notified" : true,
"dayOfMonth" : "...",
"dayOfWeek" : "..."
},
"parentEntity" : {
"referenceDescription" : "...",
"auditableFields" : [ { }, { } ],
"parentEntity" : { },
"codeChanged" : true,
"description" : "...",
"auditable" : { },
"transient" : true,
"referenceCode" : "...",
"version" : 12345,
"code" : "...",
"parentEntityType" : { },
"id" : 12345,
"notified" : true,
"appendGeneratedCode" : true,
"descriptionAndCode" : "...",
"historized" : true,
"descriptionOrCode" : "..."
},
"followingJob" : { },
"code" : "...",
"parentEntityType" : { },
"stopOnError" : true,
"limitToSingleNode" : true,
"appendGeneratedCode" : true,
"auditable" : {
"created" : 12345,
"creator" : "...",
"lastUser" : "...",
"updater" : "...",
"updated" : 12345,
"lastModified" : 12345
},
"descriptionAndCode" : "...",
"id" : 12345,
"queryScheduler" : {
"historized" : true,
"referenceDescription" : "...",
"parentEntityType" : { },
"parentEntity" : { },
"fileFormat" : "...",
"reportQuery" : { },
"emailsToNotify" : [ "...", "..." ],
"descriptionOrCode" : "...",
"isQueryScheduler" : true,
"usersToNotify" : [ { }, { } ],
"queryTimer" : { },
"transient" : true,
"referenceCode" : "...",
"auditable" : { },
"jobInstance" : { },
"codeChanged" : true,
"auditableFields" : [ { }, { } ],
"id" : 12345,
"appendGeneratedCode" : true,
"code" : "...",
"description" : "...",
"descriptionAndCode" : "...",
"version" : 12345,
"notified" : true
},
"jobTemplate" : "...",
"parentCFEntities" : [ {
"cfValuesNullSafe" : { },
"uuid" : "...",
"dirtyCF" : true,
"cfValuesAsValues" : {
"property1" : { },
"property2" : { }
},
"cfValues" : { },
"parentCFEntities" : [ { }, { } ],
"CFValuesCopy" : { },
"cfAccumulatedValuesNullSafe" : { },
"cfAccumulatedValues" : { }
}, {
"cfValuesNullSafe" : { },
"uuid" : "...",
"dirtyCF" : true,
"cfValuesAsValues" : {
"property1" : { },
"property2" : { }
},
"cfValues" : { },
"parentCFEntities" : [ { }, { } ],
"CFValuesCopy" : { },
"cfAccumulatedValuesNullSafe" : { },
"cfAccumulatedValues" : { }
} ],
"cfValues" : {
"valuesByCode" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"values" : {
"property1" : { },
"property2" : { }
},
"newVersionedCFValuePeriods" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"encrypted" : true
},
"runTimeValues" : {
"property1" : { },
"property2" : { }
},
"historized" : true,
"version" : 12345,
"referenceDescription" : "...",
"runOnNodes" : "...",
"providerCode" : "..."
},
"codeChanged" : true,
"auditableFields" : [ {
"fieldName" : "...",
"notfiable" : true,
"auditType" : "OTHER",
"historized" : true,
"previousState" : { },
"currentState" : { },
"historable" : true,
"notified" : true
}, {
"fieldName" : "...",
"notfiable" : true,
"auditType" : "OTHER",
"historized" : true,
"previousState" : { },
"currentState" : { },
"historable" : true,
"notified" : true
} ],
"id" : 12345,
"appendGeneratedCode" : true,
"code" : "...",
"description" : "...",
"descriptionAndCode" : "...",
"version" : 12345,
"notified" : true
}