SOAP API Reference › Web Services Methods › getMatchingEvents

getMatchingEvents

Use this method to obtain the list of matching events for a given subscriber.

Example

Allow partial Match True

<tns:getMatchingEvents xmlns:tns="http://www.ca.com/itpam">
<tns:auth>
<!--xsd:Choice Type-->
<tns:token>token__</tns:token>
<tns:user>Joe</tns:user>
<tns:password>thisismypassword</tns:password>
<tns:auth>
<tns:eventName>abc</tns:eventName>
<tns:eventType></tns:eventType>
<tns:eventSource></tns:eventSource>
<tns:eventDestination></tns:eventDestination>
<tns:eventExpression></tns:eventExpression>
<tns:enablePatternMatch></tns:enablePatternMatch>
<tns:allowPartialMatch>true</tns:allowPartialMatch>
<tns:consumeEvents></tns:consumeEvents>
<tns:retrieveAllMatchingEvents>true</tns:retrieveAllMatchingEvents>
<tns:uniqueId></tns:uniqueId>
</tns:getMatchingEvents>

Enable Pattern Match True

<tns:getMatchingEvents xmlns:tns="http://www.ca.com/itpam">
<tns:auth>
<tns:user>Joe</tns:user>
<tns:password>thisismypassword</tns:password>
<tns:auth>
<tns:eventName>a.*f</tns:eventName>
<tns:eventType></tns:eventType>
<tns:eventSource></tns:eventSource>
<tns:eventDestination></tns:eventDestination>
<tns:eventExpression></tns:eventExpression>
<tns:enablePatternMatch>true</tns:enablePatternMatch>
<tns:allowPartialMatch></tns:allowPartialMatch>
<tns:consumeEvents></tns:consumeEvents>
<tns:retrieveAllMatchingEvents>true</tns:retrieveAllMatchingEvents>
<tns:uniqueId></tns:uniqueId>
</tns:getMatchingEvents>

SOAP Request

<?xml version="1.0" encoding="UTF-8"?>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<tns:getMatchingEvents xmlns:tns="http://www.ca.com/itpam">
<tns:auth>
<tns:user>Joe</tns:user>
<tns:password>thisismypassword</tns:password>
<tns:auth>
<tns:eventName>abc</tns:eventName>
<tns:eventType/>
<tns:eventSource/>
<tns:eventDestination/>
<tns:eventExpression/>
<tns:enablePatternMatch/>
<tns:allowPartialMatch/>
<tns:consumeEvents/>
<tns:retrieveAllMatchingEvents>true</tns:retrieveAllMatchingEvents>
<tns:uniqueId/>
</tns:getMatchingEvents>

</SOAP-ENV:Body>

</SOAP-ENV:Envelope>

<eventName> identifies the name of the event (optional).

<eventType> identifies the type of event (optional).

<eventSource> identifies the source of the event (optional).

<eventDestination> identifies the destination of the event (optional).

<eventExpression> is a Boolean expression for additional event parameters. This expression is evaluated against the payload or event parameters that are sent with an event (optional). For example:

Event.eventid==1234.

<enablePatternMatch> enables pattern matching for the parameters like event name, type, source and destination.

<allowPartialMatch> allows a partial match for the parameters like event name, type, source and destination.

<uniqueId> sends a unique ID with the request so that the SOAP call consumes the event only once. If the send event has an option to deliver to multiple subscribers, multiple calls of getMatchingEvents with same <uniqueId> consumes the event only once.

<consumeEvents> lets the request consume or not consume the matching events.

<retrieveAllMatchingEvents> lets the request retrieve all or first matched send event.

SOAP Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<getMatchingEventsResponse xmlns="http://www.ca.com/itpam">
<events>
<event>
<eventId>fefce4c1-ad8e-42a2-8964-362704ddbb24</eventId>
<eventName>abc</eventName>
<eventType>eventType__</eventType>
<eventSource>eventSource__</eventSource>
<eventDestination>eventDestination__</eventDestination>
<payload>payload__</payload>
<toSingleSubscriber>false</toSingleSubscriber>
<eventCreationTime>2012-03-06T17:04:32.562+05:30</eventCreationTime>
<eventExpirationTime>2012-03-06T17:06:42.562+05:30</eventExpirationTime>
<user>pamadmin</user>
</event>
</events>
</getMatchingEventsResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>