IM Relationship Resolution Information Center, Version 4.2

SOA_ASSIGN_ALERT_REQUEST input document

The SOA_ASSIGN_ALERT_REQUEST input document contains the request criteria to transition an unassigned open alert to an assigned disposition and puts the alert in the assigned user’s inbox. The results of this Web services input document are returned to the calling application in a SOA_ASSIGN_ALERT_RESPONSE output document.

These UMF tags comprise the ROOT segment for the SOA_ASSIGN_ALERT_REQUEST input document:
SOURCE_TYPE
UMF tag that is required. It Identifies the type of the alert for which the disposition is being assigned.
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 we are updating the disposition. 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.
The identified alert must currently have a disposition with an ACT_STATUS_CODE value of open.
ACT_CODE_ID
UMF tag that is required. It identifies the disposition to be assigned to the alert. The value is that of a 64-bit integer number.
The disposition must be of the same alert type as that given in the SOURCE_TYPE tag.
The identified disposition must have an ACT_STATUS_CODE value of assigned.
ACT_COMMENT
UMF tag that is required. It details the reasons why the disposition is being changed for the alert.
ASSIGNED_BY_USER
UMF tag that is required. It identifies the user name of the analyst performing the change in disposition for the alert. The user should be a recognized active user.
ASSIGNED_TO_USER
UMF tag that is required. It identifies the user name of the analyst to whom the alert should be assigned. The user should be a recognized active user.

The SOAP-RPC equivalent of the SOA_ASSIGN_ALERT_REQUEST input document and the SOA_ASSIGN_ALERT_RESPONSE output document is the assignAlert method.

Example SOA_ASSIGN_ALERT_REQUEST input document

This example SOA_ASSIGN_ALERT_REQUEST requests that an alert with a SOURCE_TYPE value of CONFLICT, a SOURCE_ID value of 123456789, with an ACT_CODE_ID value of 345123987, be assigned to the user janedoe by the user johndoe, for the reason of further investigation.
Note: This example is formatted for readability and does not follow the required one line per UMF record format.
<SOA_ASSIGN_ALERT_REQUEST>
  <SOURCE_TYPE>CONFLICT</SOURCE_TYPE>
  <SOURCE_ID>123456789</SOURCE_ID>
  <ACT_CODE_ID>345123987</ACT_CODE_ID>
  <ACT_COMMENT>Assigning this alert to Jane for further investigation.</ACT_COMMENT>
  <ASSIGNED_BY_USER>johndoe</ASSIGNED_BY_USER>
  <ASSIGNED_TO_USER>janedoe</ASSIGNED_TO_USER>
</SOA_ASSIGN_ALERT_REQUEST>

Example SOA_ASSIGN_ALERT_RESPONSE output document

This example SOA_ASSIGN_ALERT_RESPONSE output document returns the status of a request identified in the SOA_ASSIGN_ALERT_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_ASSIGN_ALERT_RESPONSE>
	<ALERT_UPDATED>true</ALERT_UPDATED>
  <SYS_CREATE_DT>2008-06-26 05:18:55</SYS_CREATE_DT>
</SOA_ASSIGN_ALERT_RESPONSE>
This example SOA_ASSIGN_ALERT_RESPONSE output document returns the status of a request identified in the SOA_ASSIGN_ALERT_REQUEST input document that was not successful. In this instance, the alert was not found.
<SOA_ASSIGN_ALERT_RESPONSE>
	<ALERT_UPDATED>false</ALERT_UPDATED>
  <SYS_CREATE_DT>2008-06-26 05:18:55</SYS_CREATE_DT>
</SOA_ASSIGN_ALERT_RESPONSE>


Feedback

Last updated: 2009