Get Historic Batch

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

Method

GET /history/batch/{id}

Parameters

Path Parameters

Name	Description
id	The id of the historic batch to be retrieved.

Result

A JSON object corresponding to the HistoricBatch interface in the engine. Its properties are as follows:

Name	Value	Description
id	String	The id of the batch.
type	String	The type of the batch. See the User Guide for more information about batch types.
size	Number	The size of a batch is the number of batch execution jobs required to complete the batch.
batchJobsPerSeed	Number	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 `size` property).
invocationsPerBatchJob	Number	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.
seedJobDefinitionId	String	The job definition id for the seed jobs of this batch.
monitorJobDefinitionId	String	The job definition id for the monitor jobs of this batch.
batchJobDefinitionId	String	The job definition id for the batch execution jobs of this batch.
tenantId	String	The tenant id of the batch.
createUserId	String	The batch creator's user id.
startTime	String	The time the batch was started. Default format* `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
endTime	String	The time the batch ended. Default format* `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
removalTime	String	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.

Response codes

Code	Media type	Description
200	application/json	Request successful.
404	application/json	Historic batch with given id does not exist. See the Introduction for the error response format.

Example

Request

GET /history/batch/aBatchId

Response

Status 200.

{
  "id": "aBatchId",
  "type": "aBatchType",
  "size": 10,
  "batchJobsPerSeed": 100,
  "invocationsPerBatchJob": 1,
  "seedJobDefinitionId": "aSeedJobDefinitionId",
  "monitorJobDefinitionId": "aMonitorJobDefinitionId",
  "batchJobDefinitionId": "aBatchJobDefinitionId",
  "tenantId": "aTenantId",
  "createUserId": "aUserId",
  "startTime": "2016-04-12T15:29:33.000+0200",
  "endTime": "2016-04-12T16:23:34.000+0200",
  "removalTime": "2016-04-15T16:23:34.000+0200"
}

Options