Historic Process Instance

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.

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

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/history/process-instance/set-removal-time
  • Auth: HTTP basic

Request body

historicProcessInstanceIdsstring[] nullable

The id of the process instance.

hierarchicalboolean nullable

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

updateInChunksboolean nullable

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.

updateChunkSizeinteger nullable

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.

absoluteRemovalTimestring date-time nullable

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

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

clearedRemovalTimeboolean nullable

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.

calculatedRemovalTimeboolean nullable

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.

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.

jobsCreatedinteger nullable

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

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.

suspendedboolean nullable

Indicates whether this batch is suspended or not.

tenantIdstring nullable

The tenant id of the batch.

createUserIdstring nullable

The id of the user that created the batch.

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] (https://docs.cibseven.org/manual/2.1/reference/rest/overview/date-format/)

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/)

Changes

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