IM InfoSphere Identity Insight, Version 8.0


getEventAlertsByFilter() SOAP API method

Obtains the details of those event alerts that match the specified criteria. If the specified criteria are mutually exclusive, then no event alerts are returned. The UMF API equivalent of the getEventAlertsByFilter method are the SOA_EVENT_ALERTS_BY_FILTER_REQUEST input document and the SOA_EVENT_ALERTS_BY_FILTER_RESPONSE output document.

Syntax

getEventAlertsByFilter
(
 Filter,
 depth,
 additionalinfo
 
);

Description

Parameters
Filter
Type: EventAlertFilter
Nullable: Yes
Contains nullable fields which can be used for filtering the results. If this parameter is null then all matching event alerts are returned, subject to a the maximum number of returned alerts that are allowed by the system parameter.
depth
Abstract parameter type: DepthSpecifier
Default concrete types: DepthSetting
Nullable: Yes
This parameter indicates the level of detail for the response. If not specified, then DepthSetting FULL is assumed.
Valid Values: FULL
additionalinfo
Type: CustomInformation
Nullable: Yes
This parameter is reserved for field customizations to the WSDL and XSLT transforms without changing the signature of the method. Uncustomized, a null value is passed for this parameter. It is reserved for field customizations to the WSDL and XSLT transforms without changing the signature of the method. Professional services engineers can use this parameter to derive their own type from “CustomInformation” type in the WSDL and modify the XSLT transforms to place data from that type into UMF tags that are passed to the pipeline. In addition, they must modify the DQM Rules and UMF Builder configuration to recognize and utilize the additional data.
Example Request
EventAlertFilter filter = new EventAlertFilter();
filter.setStatus(AlertStatus.ASSIGNED);
filter.setAssignedUser(userName);

EventAlertDetail[] alerts 
    = provider.getEventAlertsByFilter(filter,
                                      DepthSetting.FULL,
                                      null);

int alertCount = 0;
if ((alerts == null) || (alerts.length == 0)) {
  System.out.println(“No alerts are assigned to the user: “ + userName);
} else {
  alertCount = alerts.length;
}

for (int index = 0; index < alertsCount; index++) {
  EventAlertDetail alert = (EventAlertDetail) alerts[index];

  AlertIdentifier alertID = alert.getAlertID();
  System.out.println(“ALERT “ + index + “ : “ + alertID.getAlertID());
}

Description

Returns
getEventAlertByFilterResponse
Nullable? = Yes
If the return value is null or an empty array then no alerts were found matching the specified criteria. Otherwise, the returned array contains one or more EventAlertDetail objects describing the matching event alerts. The degree of detail to which the EventAlertDetail objects are populated depends on the specified depth parameter.
eventAlerts
minOccurs="0"
maxOccurs="unbounded"
type="xsd_2:EventAlertDetail"
EventAlertDetail
AlertDetail
alertID
type=" xsd_1:AlertIdentifier
AlertIdentifier
alertType
type=" xsd_2:AlertType
AlertType
type="xsd:string"
Values: ROLE_ALERT, ATTRIBUTE_ALERT, TRANSACTION_ALERT, EVENT_ALERT
alertID
type="xsd:long"
timestamp
type="xsd:dateTime"
alertAnalysis
maxOccurs="unbounded"
minOccurs="0"
type=" xsd_1:AlertAnalysis
AlertAnalysis
dispositionID
type="xsd:long"
comment
type="xsd:string"
timestamp
type="xsd:dateTime"
createdBy
type="xsd:string"
dispositionID
type="xsd:long"
internalID
type="xsd:long"
entities
minOccurs="0"
maxOccurs="unbounded"
type="xsd_2:EntityDetail
EntityDetail
entityID
type="xsd:long"
largeEntity
minOccurs="0"
type="xsd:boolean"
entityType
minOccurs="0"
type="xsd:string"
bestName
minOccurs="0"
type=" xsd_1:NameDetail
NameDetail
AttributeDetail
IdentityHandle
internalID
type="xsd:long"
externalID
type="xsd:string"
dataSourceCode
type="xsd:string"
externalReference
type="xsd:string"
lastModifiedTimestamp
type="xsd:dateTime"
validFromTimestamp
type="xsd:dateTime"
validThroughTimestamp
type="xsd:dateTime"
nameID
type="xsd:long"
nameTypeCode
type="xsd:string"
givenName
type="xsd:string"
surname
type="xsd:string"
generation
type="xsd:string"
prefix
type="xsd:string"
suffix
type="xsd:string"
culture
type="xsd:string"
bestAddress
minOccurs="0"
type=" xsd_1:AddressDetail
AddressDetail
base="xsd_1:AttributeDetail"
AttributeDetail
IdentityHandle
internalID
type="xsd:long"
externalID
type="xsd:string"
dataSourceCode
type="xsd:string"
externalReference
type="xsd:string"
lastModifiedTimestamp
type="xsd:dateTime"
validFromTimestamp
type="xsd:dateTime"
validThroughTimestamp
type="xsd:dateTime"
addressID
type="xsd:long"
addressTypeCode
type="xsd:string"
street1
type="xsd:string"
street2
type="xsd:string"
street3
type="xsd:string"
city
type="xsd:string"
state
type="xsd:string"
stateAbbreviation
type="xsd:string"
country
type="xsd:string"
countryISOCode
type="xsd:string"
postalCode
type="xsd:string"
buildingType
type="xsd:string"
latitude
type="xsd:decimal"
longitude
type="xsd:decimal"
leftovers
type="xsd:string"
bestNumber
minOccurs="0"
type=" xsd_1:NumberDetail
NumberDetail
AttributeDetail
IdentityHandle
internalID
type="xsd:long"
externalID
type="xsd:string"
dataSourceCode
type="xsd:string"
externalReference
type="xsd:string"
lastModifiedTimestamp
type="xsd:dateTime"
validFromTimestamp
type="xsd:dateTime"
validThroughTimestamp
type="xsd:dateTime"
numberID
type="xsd:long"
numberValue
type="xsd:string"
location
type="xsd:string"
numberTypeID
type="xsd:long"
userDefinedStatus
type="xsd:string"
bestEmail
minOccurs="0"
type=" xsd_1:EmailDetail
EmailDetail
AttributeDetail
IdentityHandle
internalID
type="xsd:long"
externalID
type="xsd:string"
dataSourceCode
type="xsd:string"
externalReference
type="xsd:string"
lastModifiedTimestamp
type="xsd:dateTime"
validFromTimestamp
type="xsd:dateTime"
validThroughTimestamp
type="xsd:dateTime"
emailID
type="xsd:long"
emailAddress
type="xsd:string"
userEmailType
type="xsd:string"
userDefinedStatus
type="xsd:string"
roleIDs
maxOccurs="unbounded"
minOccurs="0"
type="xsd:long"
identities
maxOccurs="unbounded"
minOccurs="0"
type=" xsd_1:IdentityDetail
identityHandle
internalID
type="xsd:long"
externalID
type="xsd:string"
dataSourceCode
type="xsd:string"
externalReference
type="xsd:string"
roleIDs
type="xsd:long"
attributes
type=" xsd_1:AttributeDetail
identityHandle
type=" xsd_1:IdentityHandle
internalID
type="xsd:long"
externalID
type="xsd:string"
dataSourceCode
type="xsd:string"
externalReference
type="xsd:string"
lastModifiedTimestamp
type="xsd:dateTime"
validFromTimestamp
type="xsd:dateTime"
validThroughTimestamp
type="xsd:dateTime"
contributingEvents
minOccurs="0"
maxOccurs="unbounded"
type="xsd_2:EventDetail
EventDetail
identityHandle
type=" xsd_1:IdentityHandle"
IdentityHandle
internalID
type="xsd:long"
externalID
type="xsd:string"
dataSourceCode
type="xsd:string"
externalReference
type="xsd:string"
internalID
type="xsd:long"
eventReference
type="xsd:string"
eventTypeID
type="xsd:long"
location
type="xsd:string"
memo1
type="xsd:long"
memo2
type="xsd:long"
quantity
type="xsd:decimal"
value
type="xsd:decimal"
unitValue
type="xsd:decimal"
startDate
type="xsd:dateTime"
endDate
type="xsd:dateTime"
timestamp
type="xsd:dateTime"
reasonCode
type=" xsd:string
reasonDescription
type=" xsd:string
condition
type=" xsd:string
Exceptions
[Generic Fault]
Cause: An internal failure occurred.




Feedback



Last updated: 2011