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,
additionaInfo,
);
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: No
- 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: No
- 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
- Value:
- RoleAlertDetail
- Value:
- AlertDetail
- Value:
- alertID
- Type: xsd_1:AlertIdentifier
- Value:
- alertIdentifier
- Value:
- alertType
- Type: xsd_2:AlertType
- Value:
- AlertType
- Type: xsd:string
- Values: ROLE_ALERT, ATTRIBUTE_ALERT, TRANSACTION_ALERT
- alertID
- Type: xsd:long
- timestamp
- Type: xsd:dateTime
- alertAnalysis
- maxOccurs="unbounded"
- minOccurs="0"
- Type: xsd_1:AlertAnalysis
- Value:
- alertAnalysis
- Value:
- 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
- Value:
- EntityDetail
- Value:
- entityID
- Type: xsd:long
- largeEntity
- minOccurs="0"
- Type: xsd:boolean
- entityType
- minOccurs="0"
- Type: xsd:string
- bestName
- minOccurs="0"
- Type: xsd_1:NameDetail
- Value:
- NameDetail
- Value:
- AttributeDetail
- Value:
- IdentityHandle
- Value:
- 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
- Value:
- AddressDetail
- Value:
- AttributeDetail
- Value:
- IdentityHandle
- Value:
- 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
- Value:
- NumberDetail
- Value:
- AttributeDetail
- Value:
- IdentityHandle
- Value:
- 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
- Value:
- EmailDetail
- Value:
- AttributeDetail
- Value:
- IdentityHandle
- Value:
- 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
- Value:
- identityHandle
- Value:
- 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
- Value:
- identityHandle
- Type: xsd_1:IdentityHandle
- Value:
- 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
- Value:
- RelationshipPath
- Value:
- 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
- Value:
- Relationship
- Value:
- fromEntityID
- Type: xsd:long
- toEntityID
- Type: xsd:long
- resolutionDetail
- Type: xsd_2:ResolutionDetail
- Value:
- ResolutionDetail
- Value:
- 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>