Requests and obtains the role alerts that match specified
criteria. The UMF API equivalent of the getRoleAlerts method
are the SOA_ROLE_ALERTS_REQUEST input document and the SOA_ROLE_ALERTS_RESPONSE
output document.
Syntax
getRoleAlerts
(
status,
assignedUser,
dispositionID
alertRuleID,
fromTimeStamp,
toTimeStamp,
depth,
additionalinfo
);
Description
Parameters
- status
- Type: AlertStatus
- Nullable: Yes
- This parameter identifies the AlertStatus by which the returned
role alerts should be filtered.
- Valid values are: UNASSIGNED, ASSIGNED, CLOSED, AND SUPPRESSED.
- assignedUser
- Type: String
- Nullable: Yes
- This parameter identifies the user the alerts is assigned to.
- dispositionID
- Type: long integer (64-bit)
- Nullable: Yes
- This parameter identifies the internal ID of the specific disposition
by which the returned role alerts should be filtered. If this is
specified as a negative number, then role alerts with any disposition
are returned, otherwise, only alerts with the specified disposition
are returned.
- alertRuleID
- Type: long integer (64-bit)
- Nullable: Yes
- This parameter identifies the specific RoleAlertRule for filtering
the alerts that will be returned. If this is negative number then
the returned role alerts will not be filtered, otherwise it will be
interpreted as a rule ID.
- fromTimestamp
- Type: Date/Time
- Nullable: Yes
- This parameter identifies 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
(specifying 2009-01-01T12:00:00 will obtain all alerts created at
that time and later). Making the lower bound inclusive should help
with accounting for fractional seconds.
- The format of provided dates should be in ISO-8601. YYYY-MM-DDThh:mm:ss
- toTimestamp
- Type: Date/Time
- Nullable: Yes
- This parameter identifies 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
(specifying 2009-01-02T12:00:00 will only return alerts created prior
to that time, but not at that time). Making the upper bound exclusive
should help with accounting for fractional seconds.
- The format of provided dates should be in ISO-8601. YYYY-MM-DDThh:mm:ss
- depth
- Type: DepthSetting
- Nullable: Yes
- This parameter indicates the level of detail for the response.
If not specified, then 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.
Example Request
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getRoleAlerts xmlns="http://services/">
<status xmlns="">UNASSIGNED</status>
<assignedUser xsi:nil="true" xmlns=""/>
<dispositionID xmlns="">1</dispositionID>
<alertRuleID xmlns="">1</alertRuleID>
<fromTimestamp xsi:nil="true" xmlns=""/>
<toTimestamp xsi:nil="true" xmlns=""/>
<depth xsi:type="ns1:DepthSetting" xmlns:ns1="http://common/" xmlns="">
<value>FULL</value>
</depth>
<additionalInfo xsi:nil="true" xmlns=""/>
</getRoleAlerts>
</soapenv:Body>
</soapenv:Envelope>
Description
Returns
- getRoleAlertsResponse
- type="xsd_2:RoleAlertDetail"
- RoleAlertDetail
- 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"
- roleAlertRuleID
- type="xsd:long"
- entities
- 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"
- relationshipPath
- type=" xsd_3:RelationshipPath
- RelationshipPath
- fromEntityID
- type="xsd:long"
- toEntityID
- type="xsd:long"
- pathStrength
- minOccurs="0"
- type="xsd:float
- degreesOfSeparation
- minOccurs="0"
- type="xsd:int
- relationships
- maxOccurs="unbounded"
- minOccurs="0"
- type=" xsd_1:Relationship
- Relationship
- fromEntityID
- type="xsd:long"
- toEntityID
- type="xsd:long"
- resolutionDetail
- type=" xsd_2:ResolutionDetail
- ResolutionDetail
- relationshipConfidence
- minOccurs="0"
- type="xsd:int
- likenessConfidence
- minOccurs="0"
- type="xsd:int
- resolutionID
- minOccurs="0"
- type="xsd:long"
- resolutionRuleID
- minOccurs="0"
- type="xsd:long"
- resolutionRuleDescription
- minOccurs="0"
- type="xsd:string"
- contributors
- maxOccurs="unbounded"
- minOccurs="0"
- type=" xsd_1:ResolutionContributor
- adjustedPathStrength
- type="xsd:float:
Example Response
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soapenv:Body>
<getRoleAlertsResponse xmlns="http://services/">
<alerts xmlns="">
<alertID>
<alertType>ROLE_ALERT</alertType>
<alertID>1</alertID>
</alertID>
<timestamp>2008-07-28T15:11:51</timestamp>
<dispositionID>1</dispositionID>
<roleAlertRuleID>1</roleAlertRuleID>
<entities>
<entityID>2</entityID>
<roleIDs>1</roleIDs>
<largeEntity>FALSE</largeEntity>
<entityType>PERSON</entityType>
<bestName>
<identityHandle>
<internalID>3</internalID>
<externalID>190-020028</externalID>
<dataSourceCode>100</dataSourceCode>
<externalReference>190-020028</externalReference>
</identityHandle>
<lastModifiedTimestamp>2008-07-28T15:11:51</lastModifiedTimestamp>
<nameID>3</nameID>
<nameTypeCode>M</nameTypeCode>
<givenName>WILLIAM</givenName>
<surname>BROWNSR</surname>
</bestName>
<bestAddress>
<identityHandle>
<internalID>3</internalID>
<externalID>190-020028</externalID>
<dataSourceCode>100</dataSourceCode>
<externalReference>190-020028</externalReference>
</identityHandle>
<lastModifiedTimestamp>2008-07-28T15:11:51</lastModifiedTimestamp>
<addressID>4</addressID>
<addressTypeCode>O</addressTypeCode>
<street1>111 First St</street1>
<city>LV</city>
<state>NV</state>
<country>USA</country>
<postalCode>89110</postalCode>
</bestAddress>
<bestNumber>
<identityHandle>
<internalID>3</internalID>
<externalID>190-020028</externalID>
<dataSourceCode>100</dataSourceCode>
<externalReference>190-020028</externalReference>
</identityHandle>
<lastModifiedTimestamp>2008-07-28T15:11:51</lastModifiedTimestamp>
<numberID>3</numberID>
<numberTypeID>2</numberTypeID>
<numberValue>191-54-2667</numberValue>
</bestNumber>
</entities>
<relationshipPath>
<fromEntityID>2</fromEntityID>
<toEntityID>2</toEntityID>
<pathStrength>100.00</pathStrength>
<degreesOfSeparation>0</degreesOfSeparation>
</relationshipPath>
<adjustedPathStrength>100.00</adjustedPathStrength>
</alerts>
<alerts xmlns="">
<alertID>
<alertType>ROLE_ALERT</alertType>
<alertID>2</alertID>
</alertID>
<timestamp>2008-07-28T15:11:51</timestamp>
<dispositionID>1</dispositionID>
<roleAlertRuleID>1</roleAlertRuleID>
<entities>
<entityID>2</entityID>
<roleIDs>1</roleIDs>
<largeEntity>FALSE</largeEntity>
<entityType>PERSON</entityType>
<bestName>
<identityHandle>
<internalID>3</internalID>
<externalID>190-020028</externalID>
<dataSourceCode>100</dataSourceCode>
<externalReference>190-020028</externalReference>
</identityHandle>
<lastModifiedTimestamp>2008-07-28T15:11:51</lastModifiedTimestamp>
<nameID>3</nameID>
<nameTypeCode>M</nameTypeCode>
<givenName>WILLIAM</givenName>
<surname>BROWNSR</surname>
</bestName>
<bestAddress>
<identityHandle>
<internalID>3</internalID>
<externalID>190-020028</externalID>
<dataSourceCode>100</dataSourceCode>
<externalReference>190-020028</externalReference>
</identityHandle>
<lastModifiedTimestamp>2008-07-28T15:11:51</lastModifiedTimestamp>
<addressID>4</addressID>
<addressTypeCode>O</addressTypeCode>
<street1>111 First St</street1>
<city>LV</city>
<state>NV</state>
<country>USA</country>
<postalCode>89110</postalCode>
</bestAddress>
<bestNumber>
<identityHandle>
<internalID>3</internalID>
<externalID>190-020028</externalID>
<dataSourceCode>100</dataSourceCode>
<externalReference>190-020028</externalReference>
</identityHandle>
<lastModifiedTimestamp>2008-07-28T15:11:51</lastModifiedTimestamp>
<numberID>3</numberID>
<numberTypeID>2</numberTypeID>
<numberValue>191-54-2667</numberValue>
</bestNumber>
</entities>
<entities>
<entityID>3</entityID>
<roleIDs>1</roleIDs>
<largeEntity>FALSE</largeEntity>
<entityType>PERSON</entityType>
<bestName>
<identityHandle>
<internalID>4</internalID>
<externalID>190-030025</externalID>
<dataSourceCode>100</dataSourceCode>
<externalReference>190-030025</externalReference>
</identityHandle>
<lastModifiedTimestamp>2008-07-28T15:11:51</lastModifiedTimestamp>
<nameID>4</nameID>
<nameTypeCode>M</nameTypeCode>
<givenName>MICHAELJR</givenName>
<surname>CARSON</surname>
</bestName>
<bestAddress>
<identityHandle>
<internalID>4</internalID>
<externalID>190-030025</externalID>
<dataSourceCode>100</dataSourceCode>
<externalReference>190-030025</externalReference>
</identityHandle>
<lastModifiedTimestamp>2008-07-28T15:11:51</lastModifiedTimestamp>
<addressID>5</addressID>
<addressTypeCode>H</addressTypeCode>
<street1>1-2-2 Kinshi</street1>
<city>Tokyo</city>
<country>Japan</country>
<postalCode>130-0013</postalCode>
</bestAddress>
<bestNumber>
<identityHandle>
<internalID>4</internalID>
<externalID>190-030025</externalID>
<dataSourceCode>100</dataSourceCode>
<externalReference>190-030025</externalReference>
</identityHandle>
<lastModifiedTimestamp>2008-07-28T15:11:51</lastModifiedTimestamp>
<numberID>4</numberID>
<numberTypeID>2</numberTypeID>
<numberValue>191-54-2667</numberValue>
</bestNumber>
</entities>
<relationshipPath>
<fromEntityID>2</fromEntityID>
<toEntityID>3</toEntityID>
<pathStrength>75.00</pathStrength>
<degreesOfSeparation>1</degreesOfSeparation>
</relationshipPath>
<adjustedPathStrength>75.00</adjustedPathStrength>
</alerts>
<alerts xmlns="">
<alertID>
<alertType>ROLE_ALERT</alertType>
<alertID>3</alertID>
</alertID>
<timestamp>2008-07-28T15:11:51</timestamp>
<dispositionID>1</dispositionID>
<roleAlertRuleID>1</roleAlertRuleID>
<relationshipPath>
<fromEntityID>18</fromEntityID>
<toEntityID>21</toEntityID>
<pathStrength>60.00</pathStrength>
<degreesOfSeparation>1</degreesOfSeparation>
</relationshipPath>
<adjustedPathStrength>60.00</adjustedPathStrength>
</alerts>
</getRoleAlertsResponse>
</soapenv:Body>
</soapenv:Envelope>