Class: DoPurgeRequest

tibco.objectapi.service.request.DoPurgeRequest

new DoPurgeRequest(templates)

Object DoPurgeRequest Usage: RestApiService.getAuditService().doPurge(request, callback);
Parameters:
Name Type Description
templates tibco.objectapi.ec.base.ProcessTemplates A ProcessTemplates element, which is an array of process templates. You can specify the process templates to be considered for purging by specifying either their IDs or their names. You can combine both forms of template identification in the same request.

With either method of identification, each repetition specifies a process template. All data relating to eligible process instances of a specified template is deleted. Which instances are eligible for deletion depends on the setting of threshold.

If neither form of template identifier is specified, the operation defaults to all templates.

  • processTemplateIdIdentifier: The process template IDs, corresponding to a unique process template name, module name, and module version, can be obtained from proc_tpl_pk in the ec_pe_status database table or from proc_tpl_name in the ec_proc_template table.
  • processTemplateIdName: The name of the process template. If the name is unique throughout the system, it is sufficient identification by itself. If not, you can specify the moduleName and the version of the template to complete a unique identification. You can obtain naming information by calling listProcessTemplates.
Note that if a process includes sub-processes, you must specify only the main process. Specifying a sub-process name or template ID, either alone or together with the main process, may cause an error.
Since:
  • 4.0.0

Members

advancedOptions :string

Query parameter: 'advancedoptions' (not used)
Type:
  • string
Since:
  • 4.0.0

batchSize :string

Query parameter: 'batchsize' (optional) The number of process instances to be deleted before the transaction is committed.
Type:
  • string
Since:
  • 4.0.0
Default Value:
  • = -1

requireAllExtendedData :boolean

Query parameter: 'requireallextendeddata' (optional) If true, return all the available extended data.
Type:
  • boolean
Since:
  • 4.0.0
Default Value:
  • = false

requiredExtendedData :string

Query parameter: 'requiredextendeddata' (optional) Specifies one or more specific items of extended data (separated by semi-colons) to display. For possible values, see "Purge Audit Status" in the Developer Guide.
Type:
  • string
Since:
  • 4.0.0
Default Value:
  • = ""

runInBackground :boolean

Query parameter: 'runinbackground' (optional) If true, the purge takes place in background and the service returns immediately. If false, the service waits for the purge to complete before returning.
Type:
  • boolean
Since:
  • 4.0.0

threshold :string

Query parameter: 'threshold' (optional) The threshold date before which process instances must have been completed, cancelled, or failed if they are to be eligible to be purged. If this parameter is not specified, the data for all completed, cancelled, and failed process instances will be deleted.

The date and time must be in the format defined in "Using DateTime Literals" in the Developer Guide. For example:

2015-02-10T11:34:22.222Z

Type:
  • string
Since:
  • 4.0.0