IM InfoSphere Identity Insight, Version 8.0

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.

These UMF tags comprise the ROOT segment for the SOA_RELATIONSHIP_BETWEEN_ENTITIES_REQUEST input document:
From_ENTITY_ID
Identifies the entity from which the relationship path should originate. This tag should not be provided if the FROM_DSRC_CODE or FROM_DSRC_ACCT tags are provided.
Required? Yes, if FROM_DSRC_ACCT is not provided.
FROM_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 FROM_ENTITY_ID tag is provided. This tag should always be accompanied by the FROM_DSRC_CODE tag.
Required? Yes, if FROM_ENTITY_ACCT is not provided.
FROM_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 FROM_ENTITY_ID tag is provided. This tag should always be accompanied by the FROM_DSRC_ACCT tag.
Required? Yes, if the FROM_DSRC_ACCT tag is provided.
TO_ENTITY_ID
Identifies the entity at which the relationship path should terminate. This tag should not be provided if the FROM_DSRC_CODE or TO_DSRC_ACCT tags are provided.
Required? Yes, if TO_DSRC_ACCT is not provided.
TO_DSRC_ACCT
Identifies an identity record (within a specific data source) of the entity at which the relationship path should terminate. This tag should not be provided if the TO_ENTITY_ID tag is provided. This tag should always be accompanied by the TO_DSRC_CODE tag.
Required? Yes, if the FROM_DSRC_ACCT tag is provided.
TO_DSRC_CODE
Identifies the data source for the identity record of the entity at which the relationship path should terminate. This tag should not be provided if the TO_ENTITY_ID tag is provided. This tag should always be accompanied by the TO_DSRC_ACCT tag.
Required? Yes, if the TO_DSRC_ACCT tag is provided.
DEPTH
Indicates the level of detail for the response. If not specified, then FULL is assumed. The recognized value is FULL. Currently, FULL is the only recognized value.
Required? No

The SOAP-RPC equivalent of the SOA_RELATIONSHIP_BETWEEN_ENTITIES_REQUEST input document and the SOA_RELATIONSHIP_BETWEEN_ENTITIES_RESPONSE output document is the getRelationshipBetweenEntities method.

Example SOA_RELATIONSHIP_BETWEEN_ENTITIES_REQUEST input document

This example SOA_RELATIONSHIP_BETWEEN_ENTITIES_REQUEST input document requests the details of the relationship between an entity identified by the entity ID value of 1234567 and an entity identified by the entity ID value of 8901234.
Note: This example is formatted for readability and does not follow the required one line per UMF record format.
<SOA_ENTITY_DETAIL_REQUEST>
	<ENTITY_ID>1234567</ENTITY_ID>
	<DEPTH>FULL</DEPTH>
</SOA_ENTITY_DETAIL_REQUEST>
Example 2:
<SOA_RELATIONSHIP_BETWEEN_ENTITIES_REQUEST>
	<FROM_DSRC_CODE>EMPL</FROM_DSRC_CODE>
  <FROM_DSRC_ACCT>0982</FROM_DSRC_ACCT>
	<TO_DSRC_CODE>EMPL</TO_DSRC_CODE>
  <TO_DSRC_ACCT>2115</TO_DSRC_ACCT>
	<DEPTH>STANDARD</DEPTH>
</SOA_RELATIONSHIP_BETWEEN_ENTITIES_REQUEST>
Example 3:
<SOA_RELATIONSHIP_BETWEEN_ENTITIES_REQUEST>
	<FROM_ENTITY_ID>1234567</FROM_ENTITY_ID>
	<TO_DSRC_CODE>EMPL</TO_DSRC_CODE>
  <TO_DSRC_ACCT>2115</TO_DSRC_ACCT>
	<DEPTH>STANDARD</DEPTH>
</SOA_RELATIONSHIP_BETWEEN_ENTITIES_REQUEST>

Example SOA_RELATIONSHIP_BETWEEN_ENTITIES_REQUEST output document

This example SOA_RELATIONSHIP_BETWEEN_ENTITIES_REQUEST output document requests the details of the best relationship between the two entities, if they relate at all.
<SOA_RELATIONSHIP_BETWEEN_ENTITIES_RESPONSE>
  <REL_PATH>
    <FROM_ENTITY_ID>111222333</FROM_ENTITY_ID>
    <TO_ENTITY_ID>222333444</TO_ENTITY_ID>
    <PATH_STRENGTH>65.3</PATH_STRENGTH>
    <SEP_DEGREES>3</SEP_DEGREES>
    <RELATIONSHIP>
       <FROM_ENTITY_ID>111222333</FROM_ENTITY_ID>
       <TO_ENTITY_ID>888333111</TO_ENTITY_ID>
    </RELATIONSHIP>
    <RELATIONSHIP>
       <FROM_ENTITY_ID>888333111</FROM_ENTITY_ID>
       <TO_ENTITY_ID>999222444</TO_ENTITY_ID>
    </RELATIONSHIP>
    <RELATIONSHIP>
       <FROM_ENTITY_ID>999222444</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_RELATIONSHIP_BETWEEN_ENTITIES_RESPONSE>
Output document elements:
REL_PATH
This segment is not provided if no such relationship path exists. Otherwise, this is a standard SOA relationship path segment whose child tags are described in detail in the EnhancedSOA specification.
Required? No.
SYS_CREATE_DT
Timestamp of when the output message was generated.
Required? Yes.
Table 1. Error segments
Message ID Cause
CWUAE####E One of the entities 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_RELATIONSHIP_BETWEEN_ENTITIES_REQUEST input document and the SOA_RELATIONSHIP_BETWEEN_ENTITIES_RESPONSE output document is the getRelationshipBetweenEntities method.



Feedback

Last updated: 2011