The Expanded Service UMF API provides a pipeline UMF implementation
of the object-rich SOAP RPC API operations.
SOA_ADD_ALERT_COMMENT_REQUEST input document
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.
SOA_ADDRESS_TYPES_REQUEST input document
The SOA_ADDRESS_TYPES_REQUEST input document contains the request
and search criteria to obtain details of all configured address types. The
results of this Web services input document are returned to the calling application
in a SOA_ADDRESS_TYPES_RESPONSE output document.
SOA_ALERT_DISPOSITIONS_REQUEST input document
The SOA_ALERT_DISPOSITIONS_REQUEST input document contains the
request and search criteria to obtain details of all configured alert dispositions.
The results of this Web services input document are returned to the calling
application in a SOA_ALERT_DISPOSITIONS_REQUEST output document.
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.
SOA_CHARACTERISTIC_TYPES_REQUEST input document
The SOA_CHARACTERISTIC_TYPES_REQUEST input document contains the
request and search criteria to obtain details of all configured characteristic
types. The results of this Web services input document are returned to the
calling application in a SOA_CHARACTERISTIC_TYPES_RESPONSE output document.
SOA_CLOSE_ALERT_REQUEST input document
The SOA_CLOSE_ALERT_REQUEST input document contains the request
criteria to transition an unassigned open alert or an assigned alert to a
closed disposition. If it was previously assigned, it removes the alert from
the previously assigned user’s inbox. The results of this Web services input
document are returned to the calling application in a SOA_CLOSE_ALERT_RESPONSE
output document.
SOA_DISPOSITION_ALERT_REQUEST input document
The SOA_DISPOSITION_ALERT_REQUEST input document contains the request
criteria to change the disposition of the alert without changing the alert
status. The results of this Web services input document are returned to the
calling application in a SOA_DISPOSITION_ALERT_RESPONSE output document.
SOA_DIRECT_ENTITY_RELATIONSHIPS_REQUEST input document
The SOA_DIRECT_ENTITY_RELATIONSHIPS_REQUEST input document
contains the request and search criteria to find all direct (one-degree)
relationships for an entity regardless of path strength. The entity
is identified by its entity ID or by the external ID of one of its
constituent identity records. The results of this Web services input
document are returned to the calling application in an SOA_DIRECT_ENTITY_RELATIONSHIPS_RESPONSE
document.
SOA_ENTITY_DETAIL_REQUEST input document
The SOA_ENTITY_DETAIL_REQUEST input document contains the request
and search criteria to obtain the details of particular entity that is identified
by the entity ID or by the external ID of one of its composite identity records.
The results of this Web services input document are returned to the calling
application in a SOA_ENTITY_DETAIL_RESPONSE output document.
SOA_EVENT_ALERT_BY_ID_REQUEST input document
The SOA_EVENT_ALERT_BY_ID_REQUEST input document contains
the request and search criteria to obtain the details of an event
alert that is identified by the specified event alert ID. The results
of this Web services input document are returned to the calling application
in a SOA_EVENT_ALERT_BY_ID_RESPONSE output document.
SOA_EVENT_ALERTS_BY_FILTER_REQUEST input document
The SOA_EVENT_ALERTS_BY_FILTER_REQUEST input document contains
the request and search criteria to obtain the details of those event
alerts that match the specified criteria. The results of this Web
services input document are returned to the calling application in
a SOA_EVENT_ALERTS_BY_FILTER_RESPONSE output document.
SOA_EVENT_DETAIL_BY_ID_REQUEST input document
The SOA_EVENT_DETAIL_BY_ID_REQUEST input document contains
the request and search criteria to obtain the details of the event
that matches the specified ID. The results of this Web services input
document are returned to the calling application in a SOA_EVENT_DETAIL_BY_ID_REQUEST
output document.
SOA_EVENT_DETAILS_REQUEST input document
The SOA_EVENT_DETAILS_REQUEST input document contains the
request and search criteria to obtain the details of those events
that match the specified criteria. The results of this Web services
input document are returned to the calling application in a SOA_EVENT_DETAILS_RESPONSE
output document.
SOA_EVENT_TYPES_REQUEST input document
The SOA_EVENT_TYPES_REQUEST input document contains the
request criteria to obtain details of all configured event types.
The results of this Web services input document are returned to the
calling application in a SOA_EVENT_TYPES_RESPONSE output document.
SOA_IDENTITIES_FOR_ENTITY_REQUEST input document
The SOA_IDENTITIES_FOR_ENTITY_REQUEST input document contains the
request and search criteria to obtain the details of all identities that comprise
a specific entity that is identified by an entity ID or by the external ID
and data source code of one of its composite identities. The results of this
Web services input document are returned to the calling application in a SOA_IDENTITIES_FOR_ENTITY_RESPONSE
output document.
SOA_IDENTITY_DETAIL_REQUEST input document
The SOA_IDENTITY_DETAIL_REQUEST input document contains the request
and search criteria to obtain the details of particular identity that is identified
by the external ID of one of its composite identity records. The results of
this Web services input document are returned to the calling application in
a SOA_IDENTITY_DETAIL_RESPONSE output document.
SOA_NAME_TYPES_REQUEST input document
The SOA_NAME_TYPES_REQUEST input document contains the request
and search criteria to obtain details of all configured name types. The results
of this Web services input document are returned to the calling application
in a SOA_NAME_TYPES_RESPONSE output document.
SOA_NUMBER_TYPES_REQUEST input document
The SOA_NUMBER_TYPES_REQUEST input document contains the request
and search criteria to obtain details of all configured number types. The
results of this Web services input document are returned to the calling application
in a SOA_NUMBER_TYPES_RESPONSE output document.
SOA_RELATIONSHIP_BETWEEN_ENTITIES_REQUEST input document
The SOA_RELATIONSHIP_BETWEEN_ENTITIES_REQUEST input document
contains the request and search criteria to obtain the details of
the best relationship between the two entities, if they relate at
all. The results of this Web services input document are returned
to the calling application in a SOA_RELATIONSHIP_BETWEEN_ENTITIES_RESPONSE
output document.
SOA_ENTITY_RELATIONSHIPS_BY_STRENGTH_REQUEST input document
The SOA_ENTITY_RELATIONSHIPS_BY_STRENGTH_REQUEST input
document contains the request and search criteria to obtain all best-path
relationships to all related entities where the paths originate from
a specific entity identified either by entity ID or by the external
ID and data source code of a composite identity where the relationship
paths have a strength that is no less than the specified relationship
strength. The results of this Web services input document are returned
to the calling application in a SOA_ENTITY_RELATIONSHIPS_BY_STRENGTH_RESPONSE
document.
SOA_REOPEN_ALERT_REQUEST input document
The SOA_REOPEN_ALERT_REQUEST input document contains the request
criteria to reopen a closed alert (transition a closed alert to an unassigned
open disposition). The results of this Web services input document are returned
to the calling application in a SOA_REOPEN_ALERT_RESPONSE output document.
SOA_ROLE_ALERT_BY_ID_REQUEST input document
The SOA_ROLE_ALERT_BY_ID_REQUEST input document contains
the request and search criteria to obtain the details of a role alert that
is identified by the specified role alert ID. The results of this Web services
input document are returned to the calling application in a SOA_ROLE_ALERT_BY_ID_RESPONSE
output document.
SOA_ROLE_ALERTS_BY_ENTITY_REQUEST input document
The SOA_ROLE_ALERTS_BY_ENTITY_REQUEST input document contains the
request and search criteria to obtain the details of all role alerts for a
specific entity that is identified by its entity ID or by the external ID
of one of its composite identity records. The results of this Web services
input document are returned to the calling application in a SOA_ROLE_ALERTS_BY_ENTITY_RESPONSE
output document.
SOA_ROLE_ALERTS_REQUEST input document
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.
SOA_ROLE_ALERT_RULES_REQUEST input document
The SOA_ROLE_ALERT_RULES_REQUEST input document contains
the request and search criteria to obtain details of all configured
role alert rules. The results of this Web services input document
are returned to the calling application in a SOA_ROLE_ALERT_RULES_RESPONSE
output document.
SOA_ROLES_REQUEST input document
The SOA_ROLES_REQUEST input document contains the request and search
criteria to obtain details of all configured roles. The results of this Web
services input document are returned to the calling application in a SOA_ROLES_RESPONSE
output document.
SOA_UNASSIGN_ALERT_REQUEST input document
The SOA_UNASSIGN_ALERT_REQUEST input document contains
the request criteria to unnassign an alert (transition an assigned alert to
an unassigned open disposition and removes the alert from the previously assigned
user’s inbox). The results of this Web services input document are returned
to the calling application in a SOA_UNASSIGN_ALERT_RESPONSE output document.