The SOA_ROLE_ALERTS_REQUEST input document contains the
request and search criteria to obtain the details of role alerts that
match the specified criteria. If the specified criteria are mutually
exclusive, then no role alerts are returned. The results of this Web
services input document are returned to the calling application in
a SOA_ROLE_ALERTS_RESPONSE output document.
These UMF tags comprise the ROOT segment for the SOA_ROLE_ALERTS_REQUEST
input document:
- ACT_STATUS_CODE
- UMF tag that is optional. It Identifies the AlertStatus by which
the returned role alerts should be filtered.
- If this tag is not provided or is empty, then role alerts with
any status will be returned.
- ASSIGNED_USER
- UMF tag that is optional. It identifies the assigned user by which
the returned role alerts should be filtered.
- If this tag is not provided or is empty, then role alerts for
any user will be returned (including those that have not yet been
assigned to a specific user).
- ACT_CODE_ID
- UMF tag that is optional. The specific disposition by which the
returned role alerts should be filtered.
- If this tag is not provided or is empty, then role alerts with
any disposition are returned, otherwise, only alerts with the specified
disposition are returned.
- CONFLICT_RULE_ID
- UMF tag that is optional. It identifies the specific RoleAlertRule
for filtering the alerts that will be returned.
- If this tag is not provided, is empty, or is a negative number
then the returned role alerts will not be filtered, otherwise it will
be interpreted as a rule ID.
- FROM_CONFLICT_DT
- UMF tag that is optional. The alert creation timestamp that acts
as an inclusive lower bound to filter the returned alerts by their
creation time.If the alerts were created before the specified timestamp
then they will not be returned.
- If this tag is not provided or is empty then no lower bound is
placed on the timestamp. If specified, the lower bound is inclusive
(specifying 2009-01-01T12:00:00 will obtain all alerts created at
that time and later). Making the lower bound inclusive should help
with accounting for fractional seconds.
- The format of provided dates should be in ISO-8601. YYYY-MM-DDThh:mm:ss
- TO_CONFLICT_DT
- UMF tag that is optional. The alert creation timestamp that acts
as an exclusive upper bound to filter the returned alerts by their
creation time. If the alerts were created on or after the specified
timestamp then they will not be returned.
- If this tag is not provided or is empty then no upper bound is
placed on the timestamp. If specified, the lower bound is exclusive
(specifying 2009-01-02T12:00:00 will only return alerts created prior
to that time, but not at that time). Making the upper bound exclusive
should help with accounting for fractional seconds.
- The format of provided dates should be in ISO-8601. YYYY-MM-DDThh:mm:ss
- DEPTH
- Depth level UMF tag that is optional. It indicates the level of
detail for the response. If not specified, then FULL is assumed. Currently,
FULL is the only level available.
The SOAP-RPC equivalent of the SOA_ROLE_ALERTS_REQUEST
input document and the SOA_ROLE_ALERTS_RESPONSE output document is
the getRoleAlerts method.
Example SOA_ROLE_ALERTS_REQUEST input document
This
example SOA_ROLE_ALERTS_REQUEST query requests the details of role
alerts that are identified by the ASSIGNED_USER value of
johndoe, that occurred between January
25th and 31st, 2008. It displays the results at the FULL depth level.
Note: This
example is formatted for readability and does not follow the required
one line per UMF record format.
<SOA_ROLE_ALERTS_REQUEST>
<ASSIGNED_USER>johndoe</ASSIGNED_USER>
<FROM_CONFLICT_DT>2008-01-25<FROM_CONFLICT_DT>
<TO_CONFLICT_DT>2008-01-31</TO_CONFLICT_DT>
<DEPTH>FULL</DEPTH>
</SOA_ROLE_ALERTS_REQUEST>
Example SOA_ROLE_ALERTS_RESPONSE output document
This
example SOA_ROLE_ALERTS_RESPONSE output document returns the details
of role alerts that are identified in the SOA_ROLE_ALERTS_REQUEST
input document.
Note: This example is formatted for readability and
does not follow the required one line per UMF record format.
<SOA_ROLE_ALERTS_RESPONSE>
<ALERT>
<ALERT_ID>1234567</ALERT_ID>
<CONFLICT_RULE_ID>15</CONFLICT_RULE_ID>
<ENTITY>
<ENTITY_ID>12121212</ENTITY_ID>
<LARGE_ENTITY>false</LARGE_ENTITY>
<ENTITY_TYPE>PERSON</ENTITY_TYPE>
</ENTITY>
<ENTITY>
<ENTITY_ID>23232323</ENTITY_ID>
<LARGE_ENTITY>false</LARGE_ENTITY>
<ENTITY_TYPE>PERSON</ENTITY_TYPE>
</ENTITY>
</ALERT>
<ALERT>
<ALERT_ID>8901234</ALERT_ID>
<CONFLICT_RULE_ID>12</CONFLICT_RULE_ID>
<ENTITY>
<ENTITY_ID>56565656</ENTITY_ID>
<LARGE_ENTITY>false</LARGE_ENTITY>
<ENTITY_TYPE>PERSON</ENTITY_TYPE>
</ENTITY>
<ENTITY>
<ENTITY_ID>78787878</ENTITY_ID>
<LARGE_ENTITY>false</LARGE_ENTITY>
<ENTITY_TYPE>PERSON</ENTITY_TYPE>
</ENTITY>
</ALERT>
<SYS_CREATE_DT>2008-06-26 05:18:55</SYS_CREATE_DT>
</SOA_ROLE_ALERTS_RESPONSE>