Skip to main content
POST
/
history
/
process-instance
/
set-removal-time
curl --request POST \
  --url http://{host}:{port}/{contextPath}/history/process-instance/set-removal-time \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "absoluteRemovalTime": "2019-05-05T11:56:24.725+0200",
  "hierarchical": true,
  "historicProcessInstanceQuery": {
    "unfinished": true
  },
  "historicProcessInstanceIds": [
    "b4d2ad98-7240-11e9-98b7-be5e0f7575b7",
    "b4d2ad94-7240-11e9-98b7-be5e0f7575b7"
  ]
}'
{
  "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",
  "suspended": false,
  "createUserId": null
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
​
historicProcessInstanceIds
string[] | null

The id of the process instance.

​
historicProcessInstanceQuery
object

A historic process instance query which defines a group of historic process instances

​
hierarchical
boolean | null

Sets the removal time to all historic process instances in the hierarchy. Value may only be true, as false is the default behavior.

​
updateInChunks
boolean | null

Handles removal time updates in chunks, taking into account the defined size in removalTimeUpdateChunkSize in the process engine configuration. The size of the chunks can also be overridden per call with the updateChunkSize parameter. Enabling this option can lead to multiple executions of the resulting jobs, preventing the database transaction from timing out by limiting the number of rows to update. Value may only be true, as false is the default behavior.

​
updateChunkSize
integer | null

Defines the size of the chunks in which removal time updates are processed. The value must be a positive integer between 1 and 500. This only has an effect if updateInChunks is set to true. If undefined, the operation uses the removalTimeUpdateChunkSize defined in the process engine configuration.

​
absoluteRemovalTime
string<date-time> | null

The date for which the instances shall be removed. Value may not be null.

Note: Cannot be set in conjunction with clearedRemovalTime or calculatedRemovalTime.

​
clearedRemovalTime
boolean | null

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
boolean | null

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.

Response

Request successful.

​
id
string | null

The id of the batch.

​
type
string | null

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

​
totalJobs
integer | null

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

​
jobsCreated
integer | null

The number of batch execution jobs already created by the seed job.

​
batchJobsPerSeed
integer | null

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
integer | null

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 | null

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

​
monitorJobDefinitionId
string | null

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

​
batchJobDefinitionId
string | null

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

​
suspended
boolean | null

Indicates whether this batch is suspended or not.

​
tenantId
string | null

The tenant id of the batch.

​
createUserId
string | null

The id of the user that created the batch.

​
startTime
string<date-time> | null

The time the batch was started. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ. For further information, please see the [documentation] (https://docs.camunda.org/manual/7.22/reference/rest/overview/date-format/)

​
executionStartTime
string<date-time> | null

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.camunda.org/manual/7.22/reference/rest/overview/date-format/)