Sign in
Historic Batch

Get Historic Batch

Retrieves a historic batch by id, according to the HistoricBatch interface in the engine.

get/history/batch/{id}

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/history/batch/{id}
  • Auth: HTTP basic

Path parameters

idstring required

The id of the historic batch to be retrieved.

Response

Request successful.

idstring nullable

The id of the batch.

typestring nullable

The type of the batch. See the User Guide for more information about batch types.

totalJobsinteger nullable

The total jobs of a batch is the number of batch execution jobs required to complete the batch.

batchJobsPerSeedinteger nullable

The number of batch execution jobs created per seed job invocation. The batch seed job is invoked until it has created all batch execution jobs required by the batch (see totalJobs property).

invocationsPerBatchJobinteger nullable

Every batch execution job invokes the command executed by the batch invocationsPerBatchJob times. E.g., for a process instance migration batch this specifies the number of process instances which are migrated per batch execution job.

seedJobDefinitionIdstring nullable

The job definition id for the seed jobs of this batch.

monitorJobDefinitionIdstring nullable

The job definition id for the monitor jobs of this batch.

batchJobDefinitionIdstring nullable

The job definition id for the batch execution jobs of this batch.

tenantIdstring nullable

The tenant id of the batch.

createUserIdstring nullable

The batch creator's user id.

startTimestring date-time nullable

The time the batch was started. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ. For further information, please see the documentation

executionStartTimestring date-time nullable

The time the batch execution was started, i.e., at least one batch job has been executed. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ. For further information, please see the [documentation] (https://docs.cibseven.org/manual/2.1/reference/rest/overview/date-format/)

endTimestring date-time nullable

The time the batch ended. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ. For further information, please see the documentation

removalTimestring date-time nullable

The time after which the historic batch should be removed by the History Cleanup job. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ. For further information, please see the documentation

Changes

No recorded changes to this operation across all 1 revision of this API.