IM InfoSphere Identity Insight, Version 8.0

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.

These UMF tags comprise the ROOT segment for the SOA_DIRECT_ENTITY_RELATIONSHIPS_REQUEST input document:
ENTITY_ID
Identifies the entity from which the relationship paths should originate. This tag should not be provided if the DSRC_CODE and/or DSRC_ACCT tags are provided.
Yes, if DSRC_ACCT is not provided.
DSRC_ACCT
Identifies an identity record (within a specific data source) of the entity from which the relationship path should originate. This tag should not be provided if the ENTITY_ID tag is provided. This tag should always be accompanied by the DSRC_CODE tag when it is provided.
Yes, if ENTITY_ID is not provided.
DSRC_CODE
Identifies the data source for the identity record of the entity from which the relationship path should originate. This tag should not be provided if the ENTITY_ID tag is provided. This tag should always be accompanied by the DSRC_ACCT tag when it is provided.
Yes, if the DSRC_ACCT tag is provided.
DEPTH
Indicates the level of detail for the response. In the initial release, FULL is assumed and is the only valid value.
Required? No

The SOAP-RPC equivalent of the SOA_DIRECT_ENTITY_RELATIONSHIPS_REQUEST input document and the SOA_DIRECT_ENTITY_RELATIONSHIPS_REQUEST output document is the getDirectEntityRelationships method.

Example SOA_DIRECT_ENTITY_RELATIONSHIPS_REQUEST input document

This example SOA_DIRECT_ENTITY_RELATIONSHIPS_REQUEST input document contains the request and search criteria to find all direct (one-degree) relationships for an entity identified by the entity ID value of 1234567.
Note: This example is formatted for readability and does not follow the required one line per UMF record format.
<SOA_DIRECT_ENTITY_RELATIONSHIPS_REQUEST>
	<ENTITY_ID>1234567</ENTITY_ID>
	<DEPTH>FULL</DEPTH>
</SOA_DIRECT_ENTITY_RELATIONSHIPS_REQUEST>
Example 2:
<SOA_DIRECT_ENTITY_RELATIONSHIPS_REQUEST>
	<DSRC_CODE>EMPL</DSRC_CODE>
  <DSRC_ACCT>0982</DSRC_ACCT>
	<DEPTH>STANDARD</DEPTH>
</SOA_DIRECT_ENTITY_RELATIONSHIPS_REQUEST>

Example SOA_RELATIONSHIP_BETWEEN_ENTITIES_REQUEST output document

This example SOA_RELATIONSHIP_BETWEEN_ENTITIES_REQUEST output document contains all direct (one-degree) relationships for an entity regardless of path strength.
<SOA_DIRECT_ENTITY_RELATIONSHIPS_RESPONSE>
  <REL_PATH>
    <FROM_ENTITY_ID>111222333</FROM_ENTITY_ID>
    <TO_ENTITY_ID>888333111</TO_ENTITY_ID>
    <PATH_STRENGTH>88.4/PATH_STRENGTH>
    <SEP_DEGREES>1</SEP_DEGREES>
    <RELATIONSHIP>
       <FROM_ENTITY_ID>111222333</FROM_ENTITY_ID>
       <TO_ENTITY_ID>888333111</TO_ENTITY_ID>
    </RELATIONSHIP>
  </REL_PATH>
  <REL_PATH>
    <FROM_ENTITY_ID>111222333</FROM_ENTITY_ID>
    <TO_ENTITY_ID>222333444</TO_ENTITY_ID>
    <PATH_STRENGTH>65.3</PATH_STRENGTH>
    <SEP_DEGREES>1</SEP_DEGREES>
    <RELATIONSHIP>
       <FROM_ENTITY_ID>111222333</FROM_ENTITY_ID>
       <TO_ENTITY_ID>222333444</TO_ENTITY_ID>
    </RELATIONSHIP>
  </REL_PATH>
  <SYS_CREATE_DT>2008-06-26 05:18:55</SYS_CREATE_DT>
</SOA_DIRECT_ENTITY_RELATIONSHIPS_RESPONSE>
Output document elements:
REL_PATH
This segment is not provided if no such relationship paths exists. Otherwise, one of these segments is provided for each one-degree relationship path from the specified entity. This is a standard SOA relationship path segment whose child tags are described in the EnhancedSOA specification.
Required? Yes.
SYS_CREATE_DT
Timestamp of when the output message was generated.
Required? Yes.
Table 1. Error segments
Message ID Cause
CWUAE####E The specified entity is not recognized. (TBD==>actual error codes to be determined during implementation and provided to ID***).
CWUAE####E Input document tags are malformed. For example, required tags are missing or there are mismatched tags.

The SOAP-RPC equivalent of the SOA_DIRECT_ENTITY_RELATIONSHIPS_REQUEST input document and the SOA_RELATIONSHIP_BETWEEN_ENTITIES_RESPONSE output document is the getDirectEntityRelationships method.



Feedback

Last updated: 2011