IM Relationship Resolution Information Center, Version 4.2

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.

Syntax

assignAlert
(
 alertIdentifier,
 assignedByUser,
 assignedToUser
 assignDispositionID,
 comment,
 additionaInfo,
 
);

Description

Parameters
alertIdentifier
Type: AlertIdentifier
Nullable: No
This parameter identifies the alert for which the disposition is being updated. The identified alert must currently have a disposition with an AlertStatus of UNASSIGNED or else an exception will be thrown.
assignedByUser
Type: String
Nullable: No
This parameter identifies the user name of the analyst performing the change in disposition for the alert. The user should be a recognized active user.
assignedToUser
Type: String
Nullable: No
This parameter identifies the user name of the analyst to whom the alert should be assigned. The user should be a recognized active user.
assignedDispositionID
Type: long integer (64-bit)
Nullable: No
This parameter identifies the disposition to be assigned to the alert.
comment
Type: String
Nullable: No
This parameter details the reasons why the disposition is being changed for the alert.
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>
  <assignAlert xmlns="http://services/">
   <alertIdentifier xmlns="">
    <alertType>ROLE_ALERT</alertType>
    <alertID>81</alertID>
   </alertIdentifier>
   <assignedByUser xmlns="">admin</assignedByUser>
   <assignedToUser xmlns="">user</assignedToUser>
   <assignedDispositionID xsi:type="xsd:long" xmlns="">3</assignedDispositionID>
   <comment xmlns="">sample comment</comment>
   <additionalInfo xsi:nil="true" xmlns=""/>
  </assignAlert>
 </soapenv:Body>
</soapenv:Envelope>

Description

Returns
boolean
Values:
TRUE
request executed
FALSE
request NOT executed
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>
  <assignAlertResponse xmlns="http://services/">
   <alertAssigned xmlns="">TRUE</alertAssigned>
  </assignAlertResponse>
 </soapenv:Body>
</soapenv:Envelope>



Feedback

Last updated: 2009