ec_wsdl - PurgeOptions

complexType PurgeOptions

diagram

namespace

http://base.api.ec.n2.tibco.com

children

batchSize runInBackground threshold advancedOption processTemplates requiredExtendedData

used by

elements

doPurgeAuditRequestObject/options stopPurgeAuditRequestObject/options checkPurgeAuditRequestObject/options PurgeOptions

annotation

documentation

Provides options to control how a purge is carried out

source

<xs:complexType name="PurgeOptions">
<xs:annotation>
    <xs:documentation>Provides options to control how a purge is carried out</xs:documentation>
</xs:annotation>
<xs:sequence>
    <xs:element name="batchSize" type="xs:int" minOccurs="0" maxOccurs="1">
      <xs:annotation>
        <xs:documentation>(Optional) Number of process instances that should be deleted before the transaction is committed.

Default value: 100</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="runInBackground" type="xs:boolean" minOccurs="0" maxOccurs="1">
      <xs:annotation>
        <xs:documentation>(Optional) Boolean value specifying whether the purge runs in the background. If:
- True: The purge will run 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).</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="threshold" type="xs:dateTime" minOccurs="0" maxOccurs="1">
      <xs:annotation>
        <xs:documentation>(Optional) Date before which process instances must have been completed, cancelled or failed for them to be purged in this operation.

If this value is omitted, all completed, cancelled and failed instances will be deleted.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="advancedOption" type="AdvancedPurgeOption" minOccurs="0" maxOccurs="unbounded"/>
    <xs:element name="processTemplates" type="ProcessTemplates" minOccurs="0" maxOccurs="1"/>
    <xs:element name="requiredExtendedData" type="RequiredExtendedDataOptions" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>

WSDL documentation generated by XMLSpy WSDL Editor http://www.altova.com/xmlspy