Purge

The purge performs a physical delete of entities in the application that have previously been marked for deletion through the delete operation.

The associated child or parent entities will not be deleted by this operation.

The entities to be purged can be controlled by setting additional input parameters on the request.
Users must have one of the following permissions for the respective action (delete item or party) to call this operation:

  • PERM_PURGE_ITEM

  • PERM_PURGE_PARTY
The following table describes performance implications of using this operation:
Activity Impact Description
Purging multiple parties in a single operation call Low The more parties that are purged in a single call, the longer the operation takes to complete. Purging multiple parties in a single call takes less time than purging each party individually using separate operation calls.
Purging by lastUpdatedDate or using purgeAll Medium Purging using these options requires a query against the database before purging objects.

Purge Request

This message is sent by the client application to the TIBCO Fulfillment Subscriber Inventory system.

Purge Item Request Payload
Purge Party Request Payload
Element Type Cardinality Description
lastUpdateDate DateQueryType Choice This is a range of date for the purge.
lastUpdateDate/afterDate dateTime Optional The search is referring to elements modified after the specified date.
lastUpdateDate/beforeDate dateTime Optional The search is referring to elements modified before the specified date.
entityId String Choice This is the unique identifier for the deleted entity.
purgeAll Boolean Choice This indicates to purge all logically deleted entities.

Purge Response

This message is sent by the TIBCO Fulfillment Subscriber Inventory system to the requesting application to return the results of the operation invocation.

Purge Item Response Payload
Purge Party Response Payload
Element Type Cardinality Description
resultStatus ResultStatusType Mandatory This is the result for the request.
count long Optional This is the number of purged entities.
entity Mandatory This is the entity type returning the individual result status.

If none of the entities could be purged due to a system error, this set is empty.

If any of the entities could be deleted, there is one entity for each requested delete entity.

entity/id String Mandatory This is the unique identifier for the purged entity.