Edit on Github

Set Removal Time Async (POST)

Sets the removal time to multiple historic process instances asynchronously (batch).

At least historicProcessInstanceIds or historicProcessInstanceQuery has to be provided. If both are provided, all instances matching query criterion and instances from the list will be updated with a removal time.

Method

POST /history/process-instance/set-removal-time

Parameters

Request Body

A JSON object with the following properties:

Name	Description
absoluteRemovalTime	The date for which the historic process instances shall be removed. Value my not be `null`. Note: Cannot be set in conjunction with `clearedRemovalTime` or `calculatedRemovalTime`.
clearedRemovalTime	Sets the removal time to `null`. Value may only be `true`, as `false` is the default behavior. Note: Cannot be set in conjunction with `absoluteRemovalTime` or `calculatedRemovalTime`.
calculatedRemovalTime	The removal time is calculated based on the engine's configuration settings. Value may only be `true`, as `false` is the default behavior. Note: Cannot be set in conjunction with `absoluteRemovalTime` or `clearedRemovalTime`.
hierarchical	Sets the removal time to all historic process instances in the hierarchy. Value may only be `true`, as `false` is the default behavior.
historicProcessInstanceQuery	Query for the historic process instances to set the removal time for.
historicProcessInstanceIds	The ids of the historic process instances to set the removal time for.

Result

A JSON object corresponding to the Batch 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.
totalJobs	Number	The total jobs of a batch is the number of batch execution jobs required to complete the batch.
jobsCreated	Number	The number of batch execution jobs already created by the seed job.
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 `totalJobs` 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.
suspended	Boolean	Indicates whether this batch is suspended or not.
tenantId	String	The tenant id of the batch.
createUserId	String	The id of the user that created the batch.

Response Codes

Code	Media type	Description
204	application/json	Request successful.
400	application/json	Request was unsuccessfull due to a bad user request. This occurs if some of the query parameters are invalid, e. g. if neither historicProcessInstances nor historicProcessInstanceQuery is present or if no mode is specified. See the Introduction for the error response format.

Example

Request

POST /history/process-instance/set-removal-time

Request Body:

{
  "absoluteRemovalTime": "2019-05-05T11:56:24.725+0200",
  "hierarchical": true,
  "historicProcessInstanceQuery": {
    "unfinished": true
  },
  "historicProcessInstanceIds": [ 
    "b4d2ad98-7240-11e9-98b7-be5e0f7575b7",
    "b4d2ad94-7240-11e9-98b7-be5e0f7575b7"
  ]
}

Response

Status 200.

{
  "id": "120b568d-724a-11e9-98b7-be5e0f7575b7",
  "type": "process-set-removal-time",
  "totalJobs": 12,
  "batchJobsPerSeed": 100,
  "invocationsPerBatchJob": 1,
  "seedJobDefinitionId": "120b5690-724a-11e9-98b7-be5e0f7575b7",
  "monitorJobDefinitionId": "120b568f-724a-11e9-98b7-be5e0f7575b7",
  "batchJobDefinitionId": "120b568e-724a-11e9-98b7-be5e0f7575b7",
  "tenantId": "accounting"
}

Options