new PurgeTerminatedProcessInstancesRequest()
Object PurgeTerminatedProcessInstancesRequest
Usage:
RestApiService.getProcessManagementService().purgeTerminatedProcessInstances(request, callback);
- Since:
- 4.0.0
Members
applications :Array.<string>
Query parameter: 'applications' (Java type: List) The applications for which all the process instances in the contained process templates are to be purged.
Type:
- Array.<string>
- Since:
- 4.0.0
batchSize :number
Query parameter: 'batchsize' (Java type: int) (optional) Number of process instances that should be deleted before the transaction is committed.
Type:
- number
- Since:
- 4.0.0
- Default Value:
- = 100
instances :Array.<string>
Query parameter: 'instances' (Java type: List) The process instances to be purged.
Type:
- Array.<string>
- Since:
- 4.0.0
module :string
Query parameter: 'module' Name of the module to which the process published as a REST service belongs.
Type:
- string
- Since:
- 4.0.0
name :string
Query parameter: 'name' Name of the template attribute.
Type:
- string
- Since:
- 4.0.0
runInBackground :boolean
Query parameter: 'runinbackground' (optional) Boolean value specifying whether the purge runs in the background. If:
- True: The purge runs in the background and the operation returns immediately. This is the default value.
- False: The operation waits for the purge to complete before returning (subject to timeouts).
Type:
- boolean
- Since:
- 4.0.0
- Default Value:
- = true
states :Array.<string>
Query parameter: 'states' (Java type: List) Purge those process instances with specified state(s).
Type:
- Array.<string>
- Since:
- 4.0.0
thresholdDate :string
Query parameter: 'thresholddate' Date before which process instances must have been completed, cancelled or failed for them to be purged in this operation.
Type:
- string
- Since:
- 4.0.0
version :string
Query parameter: 'version' Version of the process template.
Type:
- string
- Since:
- 4.0.0