The SOA_ADD_ALERT_COMMENT_REQUEST input document contains the request
criteria to add a comment to an alert without changing the alert disposition
or status. The results of this Web services input document are returned to
the calling application in a SOA_ADD_ALERT_COMMENT_RESPONSE output document.
These UMF tags comprise the ROOT segment for the SOA_ADD_ALERT_COMMENT_REQUEST
input document:
- SOURCE_TYPE
- UMF tag that is required. It Identifies the type of the alert for
which the comment is being added..
- The only current recognized value is CONFLICT.
- SOURCE_ID
- UMF tag that is required. It identifies the alert within the specified
alert type for which the comment is being added. The value is that of a 64-bit
integer number.
- If the alert ID does not identify a known alert, then no update will be
performed.
- ACT_COMMENT
- UMF tag that is required. It details the reasons why the comment
is being attached to the alert.
- COMMENT_BY_USER
- UMF tag that is required. It identifies the user name of the analyst
adding the comment to the alert. The user should be a recognized active user.
The SOAP-RPC equivalent of the SOA_ADD_ALERT_COMMENT_REQUEST
input document and the SOA_ADD_ALERT_COMMENT_RESPONSE output document is the addAlertComment method.
Example SOA_ADD_ALERT_COMMENT_REQUEST input document
This
example SOA_ADD_ALERT_COMMENT_REQUEST requests that an alert with a SOURCE_TYPE
value of
CONFLICT, with
a SOURCE_ID value of
123456789,
have the comment added by the user
johndoe,
for the reason of
the alert
being interesting and to give great scrutiny to the alert.
Note: This
example is formatted for readability and does not follow the required one
line per UMF record format.
<SOA_ADD_ALERT_COMMENT_REQUEST>
<SOURCE_TYPE>CONFLICT</SOURCE_TYPE>
<SOURCE_ID>123456789</SOURCE_ID>
<ACT_COMMENT>This is an interesting alert, give great scrutiny here.</ACT_COMMENT>
<COMMENT_BY_USER>johndoe</COMMENT_BY_USER>
</SOA_ADD_ALERT_COMMENT_REQUEST>
Example SOA_ADD_ALERT_COMMENT_RESPONSE output document
This
example SOA_ADD_ALERT_COMMENT_RESPONSE output document returns the status
of a request identified in the SOA_ADD_ALERT_COMMENT_REQUEST input document
that was successful. In this instance, the alert was found and updated to
have the new disposition.
Note: This example is formatted for readability and
does not follow the required one line per UMF record format.
<SOA_ADD_ALERT_COMMENT_RESPONSE>
<ALERT_UPDATED>true</ALERT_UPDATED>
<SYS_CREATE_DT>2008-06-26 05:18:55</SYS_CREATE_DT>
</SOA_ADD_ALERT_COMMENT_RESPONSE>
This example SOA_ADD_ALERT_COMMENT_RESPONSE output document returns
the status of a request identified in the SOA_ADD_ALERT_COMMENT_REQUEST input
document that was not successful. In this instance, the alert was not found.
<SOA_ADD_ALERT_COMMENT_RESPONSE>
<ALERT_UPDATED>false</ALERT_UPDATED>
<SYS_CREATE_DT>2008-06-26 05:18:55</SYS_CREATE_DT>
</SOA_ADD_ALERT_COMMENT_RESPONSE>