The SOA_EVENT_ALERTS_BY_FILTER_REQUEST input document contains
the request and search criteria to obtain the details of those event
alerts that match the specified criteria. The results of this Web
services input document are returned to the calling application in
a SOA_EVENT_ALERTS_BY_FILTER_RESPONSE output document.
These UMF tags comprise the ROOT segment for the SOA_EVENT_ALERTS_BY_FILTER_REQUEST
input document:
- ACT_STATUS_CODE
- Required: No
- Identifies the AlertStatus by which the returned event alerts
should be filtered. If this tag is not provided or is empty, then
event alerts with any status will be returned.
- ASSIGNED_USER
- Required: No
- Identifies the assigned user by which the returned event alerts
should be filtered. If this tag is not provided or is empty, then
event alerts for any user will be returned (including those that have
not yet been assigned to a specific user).
- ACT_CODE_ID
- Required: No
- The specific disposition by which the returned event alerts should
be filtered. If this tag is not provided or is empty, then event alerts
with any disposition are returned. Otherwise, only alerts with the
specified disposition are returned.
- FROM_ALERT_DT
- Required: No
- The alert creation timestamp that acts as an inclusive lower
bound to filter the returned alerts by their creation time. If the
alerts were created before the specified timestamp then they will
not be returned. If this tag is not provided or is empty then no lower
bound is placed on the timestamp. If specified, the lower bound is inclusive.
For example, specifying Jan-01-2009 @ 12:00:00am obtains all alerts
created at that time and later. Making the lower bound inclusive helps
account for fractions of seconds. The format of provided dates should
be in ISO-8601.
- TO_ALERT_DT
- Required: No
- The alert creation timestamp that acts as an exclusive upper
bound to filter the returned alerts by their creation time. If the
alerts were created on or after the specified timestamp then they
will not be returned. If this tag is not provided or is empty then
no upper bound is placed on the timestamp. If specified, the lower
bound is exclusive. For example, specifying Jan-02-2009 @ 12:00:00am
returns alerts created prior to that time, but not at that time. Making
the upper bound exclusive helps account for fractions of seconds.
The format of provided dates should be in ISO-8601.
- ENTITY_ID
- Required: Yes, if DSRC_ACCT is not provided.
- Identifies the entity for which the event alerts are being requested.
This tag should not be provided if the DSRC_CODE or DSRC_ACCT
tags are provided.
- DSRC_ACCT
- Required: Yes, if ENTITY_ID is not provided.
- Identifies an identity record of the entity for which the event
alerts are being requested within a specific data source. This tag
should not be provided if the ENTITY_ID tag is provided. This
tag should always be accompanied by the DSRC_CODE tag when
it is provided.
- DSRC_CODE
- Required: Yes, if the DSRC_ACCT tag is provided.
- Identifies the data source for the identity record of the entity
for which the event alerts are being requested. This tag should not be
provided if the ENTITY_ID tag is provided. This tag should always be
accompanied by the DSRC_ACCT tag when it is provided.
- DEPTH
- Required: No
- It indicates the level of detail for the response. If not specified,
then FULL is assumed.
- REASON_CODE
- Required: No
- The code in CEP for the event alert type.
- REASON_DESC
- Required: No
- The description of the event alert type.
- CONDITION
- Required: No
- Not used.
Example SOA_EVENT_ALERTS_BY_FILTER_REQUEST input document
This
example SOA_EVENT_ALERTS_BY_FILTER_REQUEST query requests the details
of event alerts that are identified within a specified range of time.
Multiple filter values are "ANDED" together. As more filter types
are included, the return is increasingly restricted. "OR" functionality
is not provided.
Note: This example is formatted for readability and
does not follow the required one line per UMF record format.
<SOA_EVENT_ALERTS_REQUEST>
<ASSIGNED_USER>johndoe</ASSIGNED_USER>
<FROM_ALERT_DT>2008-01-25<FROM_ALERT_DT>
<TO_ALERT_DT>2008-01-31</TO_ALERT_DT>
<DEPTH>STANDARD</DEPTH>
</SOA_EVENT_ALERTS_REQUEST>
Example SOA_EVENT_ALERTS_BY_FILTER_RESPONSE output
document
This example SOA_EVENT_ALERTS_BY_FILTER_RESPONSE output
document returns the details of event alerts within a specified range
of time.
Note: This example is formatted for readability and does not
follow the required one line per UMF record format.
Return
value
- EVENT_ALERT
- Required: No
- Zero or more of these container tags are provided (one for each
alert matching the criteria). If not provided, then no matching alerts
matched the specified criteria. This is a standard SOA event alert
segment.
Exceptions
- [Generic Fault]
- Cause: an internal failure occurred.
Example Request
<SOA_EVENT_ALERTS_RESPONSE>
<EVENT_ALERT>
<EVENT_SIT_ID>12345</EVENT_SIT_ID>
<ACT_CODE_ID>39487</ACT_CODE_ID>
<REASON_CODE>FOO</REASON_CODE>
<REASON_DESC>BAR</REASON_DESC>
<CONDITION>PHOO</CONDITION>
<CONTRIBUTING_EVENTS>
<EVENT>
<EVENT_ID>123</EVENT_ID>
<DSRC_ACCT_ID>345</DSRC_ACCT_ID>
<DSRC_CODE>EMPL</DSRC_CODE>
<DSRC_REF>ABC</DSRC_REF>
<EVENT_REF>BAR</EVENT_REF>
<EVENT_TYPE_ID>6789</EVENT_TYPE_ID>
<EVENT_LOC>ATM 345678</EVENT_LOC>
<EVENT_MEMO1>Blah blah blah</EVENT_MEMO1>
<EVENT_MEMO2>Blah boo blah boo</EVENT_MEMO2>
<EVENT_START_DT>2009-04-23 15:50:21</EVENT_START_DT>
<EVENT_END_DT>2009-04-25 17:22:11</EVENT_END_DT>
<EVENT_QTY>456.22</EVENT_QTY>
<EVENT_UNIT_VALUE>456.22</EVENT_UNIT_VALUE>
<EVENT_VALUE>456.22</EVENT_VALUE>
<EVENT_STATUS>Open</EVENT_STATUS>
<SYS_CREATE_DT>2009-04-23 15:50:21</SYS_CREATE_DT>
<SYS_LSTUPD_DT>2009-04-23 15:50:21</SYS_CREATE_DT>
</EVENT>
<EVENT>
<EVENT_ID>145</EVENT_ID>
<DSRC_ACCT_ID>345</DSRC_ACCT_ID>
<DSRC_CODE>EMPL</DSRC_CODE>
<DSRC_REF>ABC</DSRC_REF>
<EVENT_REF>BAR</EVENT_REF>
<EVENT_TYPE_ID>6789</EVENT_TYPE_ID>
<EVENT_LOC>ATM 115178</EVENT_LOC>
<EVENT_MEMO1>Blah blah blah</EVENT_MEMO1>
<EVENT_MEMO2>Blah boo blah boo</EVENT_MEMO2>
<EVENT_START_DT>2009-03-21 13:22:11</EVENT_START_DT>
<EVENT_END_DT>2009-03-22 17:22:11</EVENT_END_DT>
<EVENT_QTY>326.13</EVENT_QTY>
<EVENT_UNIT_VALUE>326.13</EVENT_UNIT_VALUE>
<EVENT_VALUE>326.132</EVENT_VALUE>
<EVENT_STATUS>Closed</EVENT_STATUS>
<SYS_CREATE_DT>2009-03-21 13:22:11</SYS_CREATE_DT>
<SYS_LSTUPD_DT>2009-03-21 13:22:11</SYS_CREATE_DT>
</EVENT>
</CONTRIBUTING_EVENTS>
<ENTITY>
<ENTITY_ID>1234</ENTITY_ID>
. . .
</ENTITY>
</EVENT_ALERT>
<EVENT_ALERT>
. . .
</EVENT_ALERT>
<EVENT_ALERT>
. . .
</EVENT_ALERT>
<SYS_CREATE_DT>2008-06-26 05:18:55</SYS_CREATE_DT>
</SOA_EVENT_ALERTS_RESPONSE>
The intent
of this call is to "filter" the return values. The caller must supply
at least one filter value. If the request contains no filters, then
an exception is returned. This provides a check to prevent trying
to return every single event alert in the database.
If no values
are present, the pipeline returns a
5940E exception: "No filter parameters found. When performing
a filtered SOA call, at least one parameter must be present. Please
correct the input and try again."