IM Relationship Resolution Information Center, Version 4.2

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.

Syntax

unassignAlert
(
 alertIdentifier,
 unassignedByUser,
 openDispositionID,
 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 ASSIGNED or else an exception will be thrown.
unassignedByUser
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.
openDispositionID
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>
  <unassignAlert xmlns="http://services/">
   <alertIdentifier xmlns="">
    <alertType>ROLE_ALERT</alertType>
    <alertID>81</alertID>
   </alertIdentifier>
   <unassignedByUser xmlns="">admin</unassignedByUser>
   <openDispositionID xsi:type="xsd:long" xmlns="">1</openDispositionID>
   <comment xmlns="">sample comment</comment>
   <additionalInfo xsi:nil="true" xmlns=""/>
  </unassignAlert>
 </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>
  <unassignAlertResponse xmlns="http://services/">
   <alertUnassigned xmlns="">TRUE</alertUnassigned>
  </unassignAlertResponse>
 </soapenv:Body>
</soapenv:Envelope>



Feedback

Last updated: 2009