Documentation Center

EventMonitor 2.5 DeleteByProgressId

Deletes the event specified by the ProgressId.


Parameters

NameTypeDirectionDescription
psAuthContextStringInOutDeprecated proprietary authentication context only used by .ASMX web services based on internal username/password authentication. Claims based security standards drive all the WCF .SVC web services making this parameter redundant.
plProgressIdLongInThe unique identifier of the event
pbDeleteFailedEventsBooleanInBoolean that indicates if events with status FAILED should be deleted or not
pbDeleteBusyEventsBooleanInBoolean that indicates if events with status BUSY should be deleted or not

Note that:
  • If the event is a main event with sub events, the main event can only be deleted after all sub events are deleted.
  • When the event doesn't exist (anymore), an InvalidObject exception is thrown.
  • When the status of the event is FAILED and the parameter pbDeleteFailedEvents is false, an exception is raised.
  • When the status of the event is BUSY and the parameter pbDeleteBusyEvents is false, an exception is raised.