Get Purge Order Status

The getPurgeStatus operation allows you to track the status of an ongoing purge process by using the purge ID.

End-point URL: http://<HOST>:<PORT>/omsServer/api/getPurgeStatus

This method queries the purge status data store against the purge ID to return the purge status.

The request message format is:

Purge Status Request

Get Purge Order Request Data Model
Element Name Element Type Description
purgeId String

(Mandatory)

The unique id associated with purge. Eg - 07e02e7e-29e1-4e08-bc4f-1c2e05025595

The reply message format is:

Purge Status Response

Get Purge Order Response Data Model
Element Name Element Type Description
purgeStatus String

(Mandatory)

The unique id associated with purge. Eg - 07e02e7e-29e1-4e08-bc4f-1c2e05025595
ordersPurged NUMBER The number of orders purged at any given time
ordersLinesPurged NUMBER The number of order lines purged at any given time
totalOrders NUMBER Total orders to be purged
totalOrderLines NUMBER Total order lines to be purged