The alerting SOAP API methods enable the retrieval of role alert
details, and also the modification of role alert dispositions.
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.
getEventAlertByID() SOAP API method
Requests and obtains the details of an event alert that
is identified by the specified event alert ID. The UMF API equivalent
of the getEventAlertByID method are the SOA_EVENT_ALERT_BY_ID_REQUEST
input document and the SOA_EVENT_ALERT_BY_ID_RESPONSE output document.
getRoleAlertByID() SOAP API method
Requests and obtains the details of a role alert that is
identified by the specified role alert ID. The UMF API equivalent
of the getRoleAlertByID method are the SOA_ROLE_ALERT_BY_ID_REQUEST
input document and the SOA_ROLE_ALERT_BY_ID_RESPONSE output document.
getRoleAlertsByEntity() SOAP API method
Requests and obtains the details of all role alerts for
a specific entity that is identified by its entity ID or by the external
ID of one of its composite identity records. The UMF API equivalent
of the getRoleAlertsByEntity method are the SOA_ROLE_ALERTS_BY_ENTITY_REQUEST
input document and the SOA_ROLE_ALERTS_BY_ENTITY_RESPONSE output document.
getRoleAlerts() SOAP API method
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.
assignAlert() SOAP API method
Transitions an unassigned open alert to an assigned disposition
and puts the alert in the assigned user's inbox. The UMF API
equivalent of the assignAlert method are the SOA_ASSIGN_ALERT_REQUEST
input document and the SOA_ASSIGN_ALERT_RESPONSE output document.
unassignAlert() SOAP API method
Transitions an assigned alert to an unassigned open disposition
and removes the alert from the previously assigned user's inbox.
The UMF API equivalent of the unassignAlert method
are the SOA_UNASSIGN_ALERT_REQUEST input document and the SOA_UNASSIGN_ALERT_RESPONSE
output document.
dispositionAlert() SOAP API method
Changes the disposition of the alert without changing the
alert status. The UMF API equivalent of the dispositionAlert method
are the SOA_DISPOSITION_ALERT_REQUEST input document and the SOA_DISPOSITION_ALERT_RESPONSE
output document.
closeAlert() SOAP API method
Transitions an unassigned open alert or an assigned alert
to a closed disposition. The UMF API equivalent of the closeAlert method
are the SOA_CLOSE_ALERT_REQUEST input document and the SOA_CLOSE_ALERT_RESPONSE
output document.
reopenAlert() SOAP API method
Transitions a closed alert to an unassigned open disposition.
The UMF API equivalent of the reopenAlert method
are the SOA_REOPEN_ALERT_REQUEST input document and the SOA_REOPEN_ALERT_RESPONSE
output document.
addAlertComment() SOAP API method
Adds a comment to an alert without changing the alert disposition
or status. The UMF API equivalent of the addAlertComment method
are the SOA_ADD_ALERT_COMMENT_REQUEST input document and the SOA_ADD_ALERT_COMMENT_RESPONSE
output document.