IM Relationship Resolution Information Center, Version 4.2

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.

Syntax

addAlertComment
(
 alertIdentifier,
 comment,
 commentByUser,
 additionaInfo,
 
);

Description

Parameters
alertIdentifier
Type: AlertIdentifier
Nullable: No
This parameter identifies the alert for which the comment is being added.
commentByUser
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.
comment
Type: String
Nullable: No
This parameter details the reasons why the comment is being attached to 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>
  <addAlertComment xmlns="http://services/">
   <alertID xmlns="">
    <alertType>ROLE_ALERT</alertType>
    <alertID>81</alertID>
   </alertID>
   <comment xmlns="">sample comment</comment>
   <commentingUser xmlns="">admin</commentingUser>
   <additionalInfo xsi:nil="true" xmlns=""/>
  </addAlertComment>
 </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>
<addAlertCommentResponse xmlns="http://services/">
<alertUpdated xmlns="">TRUE</alertUpdated>
</addAlertCommentResponse>
</soapenv:Body>
</soapenv:Envelope>



Feedback

Last updated: 2009