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