EventMonitor 2.5 RetrieveEventOverview
Retrieves metadata of events which match the supplied filters.
Parameters
| Name | Type | Direction | Description |
|---|---|---|---|
| psAuthContext | String | InOut | Deprecated 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. |
| pasEventTypes | StringArray | In | String array containing the event types to retrieve (e.g EXPORTFORPUBLICATION, CREATETRANSLATIONFROMREPORT,...) |
| peStatusFilter | eProgressStatusFilter | In | The enumeration indicating which overall status the event must have |
| pdModifiedSince | Date | In | A date limiting the events that will be retrieved based on the last modification date of the events |
| peUserFilter | eUserFilter | In | Enumeration indicating if only events of the current user or all events must be retrieved |
| psXMLRequestedEventData | String | In | Requested Event Metadata XML structure indicating which metadata has to be retrieved for a given event |
| psOutXMLEventList | String | Out | Event List XML structure containing both the event data content (base 64 encoded) and the requested metadata. |
Note that:
- Only metadata of events (level progress) are retrieved. No event data and no metadata of the event details (level detail) will be retrieved. The
levelattribute on theishfieldelements in the parameterpsXMLRequestedEventDatamust be 'progress'. - This method will calculate (if necessary) the status for each main event using the status of the sub events. If there is a status filter provided, the calculation is done before the filtering is executed.
- If the parameter
peUserFilteris set toCurrent, only events that are associated with the current user will be retrieved. Otherwise the events associated to all users are retrieved. - If event types array is empty, then child events are not retrieved (The ones that have not empty parent progress id). This behavior is protecting the caller from potentially retrieving too many records.