| name | data type | constraints | description |
|---|---|---|---|
| referenceDescription | string | ||
| end | number | ||
| parentEntityType | object | ||
| parentEntity | BusinessEntity | ||
| year | string | ||
| description | string | max size: 255, min size: 0 | |
| month | string | ||
| second | string | ||
| appendGeneratedCode | boolean | ||
| hour | string | ||
| jobInstances | array of JobInstance | ||
| dayOfMonth | string | ||
| auditableFields | array of AuditableFieldHistory | ||
| codeChanged | boolean | ||
| auditable | Auditable | ||
| notified | boolean | ||
| timerSchedule | string | ||
| version | number | ||
| code | string | required, max size: 255, min size: 1 | |
| historized | boolean | ||
| active | boolean | ||
| minute | string | ||
| transient | boolean | ||
| disabled | boolean | ||
| dayOfWeek | string | ||
| id | number | ||
| referenceCode | string | ||
| descriptionAndCode | string | ||
| descriptionOrCode | string | ||
| start | number |
Example
{
"referenceDescription" : "...",
"end" : 12345,
"parentEntityType" : { },
"parentEntity" : {
"auditable" : {
"created" : 12345,
"lastUser" : "...",
"updated" : 12345,
"lastModified" : 12345,
"creator" : "...",
"updater" : "..."
},
"descriptionAndCode" : "...",
"descriptionOrCode" : "...",
"auditableFields" : [ {
"notfiable" : true,
"previousState" : { },
"historized" : true,
"historable" : true,
"currentState" : { },
"notified" : true,
"auditType" : "STATUS",
"fieldName" : "..."
}, {
"notfiable" : true,
"previousState" : { },
"historized" : true,
"historable" : true,
"currentState" : { },
"notified" : true,
"auditType" : "STATUS",
"fieldName" : "..."
} ],
"version" : 12345,
"parentEntityType" : { },
"historized" : true,
"referenceDescription" : "...",
"referenceCode" : "...",
"id" : 12345,
"parentEntity" : { },
"code" : "...",
"codeChanged" : true,
"description" : "...",
"transient" : true,
"notified" : true,
"appendGeneratedCode" : true
},
"year" : "...",
"description" : "...",
"month" : "...",
"second" : "...",
"appendGeneratedCode" : true,
"hour" : "...",
"jobInstances" : [ {
"description" : "...",
"runTimeParametres" : "...",
"providerCode" : "...",
"active" : true,
"excludeInvoicesWithoutAmount" : true,
"jobTemplate" : "...",
"queryScheduler" : {
"referenceDescription" : "...",
"transient" : true,
"usersToNotify" : [ { }, { } ],
"notified" : true,
"code" : "...",
"fileFormat" : "...",
"parentEntityType" : { },
"queryTimer" : { },
"isQueryScheduler" : true,
"id" : 12345,
"descriptionOrCode" : "...",
"description" : "...",
"historized" : true,
"emailsToNotify" : [ "...", "..." ],
"version" : 12345,
"referenceCode" : "...",
"codeChanged" : true,
"appendGeneratedCode" : true,
"parentEntity" : { },
"reportQuery" : { },
"descriptionAndCode" : "...",
"jobInstance" : { },
"auditableFields" : [ { }, { } ],
"auditable" : { }
},
"parentEntity" : {
"auditable" : { },
"descriptionAndCode" : "...",
"descriptionOrCode" : "...",
"auditableFields" : [ { }, { } ],
"version" : 12345,
"parentEntityType" : { },
"historized" : true,
"referenceDescription" : "...",
"referenceCode" : "...",
"id" : 12345,
"parentEntity" : { },
"code" : "...",
"codeChanged" : true,
"description" : "...",
"transient" : true,
"notified" : true,
"appendGeneratedCode" : true
},
"disabled" : true,
"followingJob" : { },
"appendGeneratedCode" : true,
"jobCategoryEnum" : "...",
"uuid" : "...",
"parentEntityType" : { },
"codeChanged" : true,
"jobSpeed" : "FAST",
"descriptionOrCode" : "...",
"timerEntity" : {
"referenceDescription" : "...",
"end" : 12345,
"parentEntityType" : { },
"parentEntity" : { },
"year" : "...",
"description" : "...",
"month" : "...",
"second" : "...",
"appendGeneratedCode" : true,
"hour" : "...",
"jobInstances" : [ { }, { } ],
"dayOfMonth" : "...",
"auditableFields" : [ { }, { } ],
"codeChanged" : true,
"auditable" : { },
"notified" : true,
"timerSchedule" : "...",
"version" : 12345,
"code" : "...",
"historized" : true,
"active" : true,
"minute" : "...",
"transient" : true,
"disabled" : true,
"dayOfWeek" : "...",
"id" : 12345,
"referenceCode" : "...",
"descriptionAndCode" : "...",
"descriptionOrCode" : "...",
"start" : 12345
},
"runOnNodes" : "...",
"executionResults" : [ {
"jobInstance" : { },
"startDate" : 12345,
"report" : "...",
"jobLauncherEnum" : "INCOMPLETE",
"moreToProcess" : true,
"version" : 12345,
"nbItemsToProcess" : 12345,
"nbItemsProcessed" : 12345,
"endDate" : 12345,
"nbItemsProcessedWithError" : 12345,
"nbItemsProcessedWithWarning" : 12345,
"id" : 12345,
"errors" : [ "...", "..." ],
"status" : "CANCELLED",
"transient" : true,
"warnings" : [ "...", "..." ],
"nbItemsCorrectlyProcessed" : 12345
}, {
"jobInstance" : { },
"startDate" : 12345,
"report" : "...",
"jobLauncherEnum" : "TIMER",
"moreToProcess" : true,
"version" : 12345,
"nbItemsToProcess" : 12345,
"nbItemsProcessed" : 12345,
"endDate" : 12345,
"nbItemsProcessedWithError" : 12345,
"nbItemsProcessedWithWarning" : 12345,
"id" : 12345,
"errors" : [ "...", "..." ],
"status" : "COMPLETED",
"transient" : true,
"warnings" : [ "...", "..." ],
"nbItemsCorrectlyProcessed" : 12345
} ],
"descriptionAndCode" : "...",
"auditable" : {
"created" : 12345,
"lastUser" : "...",
"updated" : 12345,
"lastModified" : 12345,
"creator" : "...",
"updater" : "..."
},
"referenceDescription" : "...",
"code" : "...",
"notified" : true,
"limitToSingleNode" : true,
"transient" : true,
"historized" : true,
"referenceCode" : "...",
"version" : 12345,
"cfAccumulatedValues" : {
"valuesByCode" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"values" : {
"property1" : { },
"property2" : { }
},
"newVersionedCFValuePeriods" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"encrypted" : true
},
"stopOnError" : true,
"parametres" : "...",
"cfValues" : {
"valuesByCode" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"values" : {
"property1" : { },
"property2" : { }
},
"newVersionedCFValuePeriods" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"encrypted" : true
},
"auditableFields" : [ {
"notfiable" : true,
"previousState" : { },
"historized" : true,
"historable" : true,
"currentState" : { },
"notified" : true,
"auditType" : "STATUS",
"fieldName" : "..."
}, {
"notfiable" : true,
"previousState" : { },
"historized" : true,
"historable" : true,
"currentState" : { },
"notified" : true,
"auditType" : "STATUS",
"fieldName" : "..."
} ],
"parentCFEntities" : [ {
"parentCFEntities" : [ { }, { } ],
"uuid" : "...",
"CFValuesCopy" : { },
"dirtyCF" : true,
"cfValuesAsValues" : {
"property1" : { },
"property2" : { }
},
"cfAccumulatedValuesNullSafe" : { },
"cfValuesNullSafe" : { },
"cfAccumulatedValues" : { },
"cfValues" : { }
}, {
"parentCFEntities" : [ { }, { } ],
"uuid" : "...",
"CFValuesCopy" : { },
"dirtyCF" : true,
"cfValuesAsValues" : {
"property1" : { },
"property2" : { }
},
"cfAccumulatedValuesNullSafe" : { },
"cfValuesNullSafe" : { },
"cfAccumulatedValues" : { },
"cfValues" : { }
} ],
"id" : 12345,
"runTimeValues" : {
"property1" : { },
"property2" : { }
},
"verboseReport" : true
}, {
"description" : "...",
"runTimeParametres" : "...",
"providerCode" : "...",
"active" : true,
"excludeInvoicesWithoutAmount" : true,
"jobTemplate" : "...",
"queryScheduler" : {
"referenceDescription" : "...",
"transient" : true,
"usersToNotify" : [ { }, { } ],
"notified" : true,
"code" : "...",
"fileFormat" : "...",
"parentEntityType" : { },
"queryTimer" : { },
"isQueryScheduler" : true,
"id" : 12345,
"descriptionOrCode" : "...",
"description" : "...",
"historized" : true,
"emailsToNotify" : [ "...", "..." ],
"version" : 12345,
"referenceCode" : "...",
"codeChanged" : true,
"appendGeneratedCode" : true,
"parentEntity" : { },
"reportQuery" : { },
"descriptionAndCode" : "...",
"jobInstance" : { },
"auditableFields" : [ { }, { } ],
"auditable" : { }
},
"parentEntity" : {
"auditable" : { },
"descriptionAndCode" : "...",
"descriptionOrCode" : "...",
"auditableFields" : [ { }, { } ],
"version" : 12345,
"parentEntityType" : { },
"historized" : true,
"referenceDescription" : "...",
"referenceCode" : "...",
"id" : 12345,
"parentEntity" : { },
"code" : "...",
"codeChanged" : true,
"description" : "...",
"transient" : true,
"notified" : true,
"appendGeneratedCode" : true
},
"disabled" : true,
"followingJob" : { },
"appendGeneratedCode" : true,
"jobCategoryEnum" : "...",
"uuid" : "...",
"parentEntityType" : { },
"codeChanged" : true,
"jobSpeed" : "FAST",
"descriptionOrCode" : "...",
"timerEntity" : {
"referenceDescription" : "...",
"end" : 12345,
"parentEntityType" : { },
"parentEntity" : { },
"year" : "...",
"description" : "...",
"month" : "...",
"second" : "...",
"appendGeneratedCode" : true,
"hour" : "...",
"jobInstances" : [ { }, { } ],
"dayOfMonth" : "...",
"auditableFields" : [ { }, { } ],
"codeChanged" : true,
"auditable" : { },
"notified" : true,
"timerSchedule" : "...",
"version" : 12345,
"code" : "...",
"historized" : true,
"active" : true,
"minute" : "...",
"transient" : true,
"disabled" : true,
"dayOfWeek" : "...",
"id" : 12345,
"referenceCode" : "...",
"descriptionAndCode" : "...",
"descriptionOrCode" : "...",
"start" : 12345
},
"runOnNodes" : "...",
"executionResults" : [ {
"jobInstance" : { },
"startDate" : 12345,
"report" : "...",
"jobLauncherEnum" : "API",
"moreToProcess" : true,
"version" : 12345,
"nbItemsToProcess" : 12345,
"nbItemsProcessed" : 12345,
"endDate" : 12345,
"nbItemsProcessedWithError" : 12345,
"nbItemsProcessedWithWarning" : 12345,
"id" : 12345,
"errors" : [ "...", "..." ],
"status" : "RUNNING",
"transient" : true,
"warnings" : [ "...", "..." ],
"nbItemsCorrectlyProcessed" : 12345
}, {
"jobInstance" : { },
"startDate" : 12345,
"report" : "...",
"jobLauncherEnum" : "INCOMPLETE",
"moreToProcess" : true,
"version" : 12345,
"nbItemsToProcess" : 12345,
"nbItemsProcessed" : 12345,
"endDate" : 12345,
"nbItemsProcessedWithError" : 12345,
"nbItemsProcessedWithWarning" : 12345,
"id" : 12345,
"errors" : [ "...", "..." ],
"status" : "FAILED",
"transient" : true,
"warnings" : [ "...", "..." ],
"nbItemsCorrectlyProcessed" : 12345
} ],
"descriptionAndCode" : "...",
"auditable" : {
"created" : 12345,
"lastUser" : "...",
"updated" : 12345,
"lastModified" : 12345,
"creator" : "...",
"updater" : "..."
},
"referenceDescription" : "...",
"code" : "...",
"notified" : true,
"limitToSingleNode" : true,
"transient" : true,
"historized" : true,
"referenceCode" : "...",
"version" : 12345,
"cfAccumulatedValues" : {
"valuesByCode" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"values" : {
"property1" : { },
"property2" : { }
},
"newVersionedCFValuePeriods" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"encrypted" : true
},
"stopOnError" : true,
"parametres" : "...",
"cfValues" : {
"valuesByCode" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"values" : {
"property1" : { },
"property2" : { }
},
"newVersionedCFValuePeriods" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"encrypted" : true
},
"auditableFields" : [ {
"notfiable" : true,
"previousState" : { },
"historized" : true,
"historable" : true,
"currentState" : { },
"notified" : true,
"auditType" : "RENEWAL",
"fieldName" : "..."
}, {
"notfiable" : true,
"previousState" : { },
"historized" : true,
"historable" : true,
"currentState" : { },
"notified" : true,
"auditType" : "STATUS",
"fieldName" : "..."
} ],
"parentCFEntities" : [ {
"parentCFEntities" : [ { }, { } ],
"uuid" : "...",
"CFValuesCopy" : { },
"dirtyCF" : true,
"cfValuesAsValues" : {
"property1" : { },
"property2" : { }
},
"cfAccumulatedValuesNullSafe" : { },
"cfValuesNullSafe" : { },
"cfAccumulatedValues" : { },
"cfValues" : { }
}, {
"parentCFEntities" : [ { }, { } ],
"uuid" : "...",
"CFValuesCopy" : { },
"dirtyCF" : true,
"cfValuesAsValues" : {
"property1" : { },
"property2" : { }
},
"cfAccumulatedValuesNullSafe" : { },
"cfValuesNullSafe" : { },
"cfAccumulatedValues" : { },
"cfValues" : { }
} ],
"id" : 12345,
"runTimeValues" : {
"property1" : { },
"property2" : { }
},
"verboseReport" : true
} ],
"dayOfMonth" : "...",
"auditableFields" : [ {
"notfiable" : true,
"previousState" : { },
"historized" : true,
"historable" : true,
"currentState" : { },
"notified" : true,
"auditType" : "STATUS",
"fieldName" : "..."
}, {
"notfiable" : true,
"previousState" : { },
"historized" : true,
"historable" : true,
"currentState" : { },
"notified" : true,
"auditType" : "STATUS",
"fieldName" : "..."
} ],
"codeChanged" : true,
"auditable" : {
"created" : 12345,
"lastUser" : "...",
"updated" : 12345,
"lastModified" : 12345,
"creator" : "...",
"updater" : "..."
},
"notified" : true,
"timerSchedule" : "...",
"version" : 12345,
"code" : "...",
"historized" : true,
"active" : true,
"minute" : "...",
"transient" : true,
"disabled" : true,
"dayOfWeek" : "...",
"id" : 12345,
"referenceCode" : "...",
"descriptionAndCode" : "...",
"descriptionOrCode" : "...",
"start" : 12345
}