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.
These UMF tags comprise the ROOT segment for the SOA_ENTITY_DETAIL_REQUEST
input document:
- ENTITY_ID
- Entity ID UMF tag that is required if the DSRC_ACCT and DSRC_CODE UMF
tags are not present, because it references and identifies the specific
entity ID to detail.
- DSRC_ACCT
- Data source reference UMF tag that is required if the DSRC_CODE UMF
tag is present and ENTITY_ID UMF tag is missing, because it references
and identifies the unique ID for the entity in the data source in the system
to details.
- DSRC_CODE
- Data source reference UMF tag that is required if the DSRC_CODE UMF
tag is present and ENTITY_ID UMF tag is missing, because it references
and identifies the data source in the system to detail.
- 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_ENTITY_DETAIL_REQUEST
input document and the SOA_ENTITY_DETAIL_RESPONSE output document is the getEntityDetail method.
Example SOA_ENTITY_DETAIL_REQUEST input document
This
example SOA_ENTITY_DETAIL_REQUEST query requests the details of particular
entity that is 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_ENTITY_DETAIL_REQUEST>
<ENTITY_ID>1234567</ENTITY_ID>
<DEPTH>FULL</DEPTH>
</SOA_ENTITY_DETAIL_REQUEST>
This example SOA_ENTITY_DETAIL_REQUEST query requests the details of
particular entity that is identified by the data source value
EMPL,
and the unique ID for the entity in the data source value of
0982.
Note: This
example is formatted for readability and does not follow the required one
line per UMF record format.
<SOA_ENTITY_DETAIL_REQUEST>
<DSRC_CODE>EMPL</DSRC_CODE>
<DSRC_ACCT>0982</DSRC_ACCT>
<DEPTH>FULL</DEPTH>
</SOA_ENTITY_DETAIL_REQUEST>
Example SOA_ENTITY_DETAIL_RESPONSE output document
This
example SOA_ENTITY_DETAIL_RESPONSE output document returns the details of
role alerts that are identified by the entity ID value of
12121212.
Note: This
example is formatted for readability and does not follow the required one
line per UMF record format.
<SOA_ENTITY_DETAIL_RESPONSE>
<ENTITY>
<ENTITY_ID>12121212</ENTITY_ID>
<LARGE_ENTITY>false</LARGE_ENTITY>
<ENTITY_TYPE>PERSON</ENTITY_TYPE>
</ENTITY>
<SYS_CREATE_DT>2008-06-26 05:18:55</SYS_CREATE_DT>
</SOA_ENTITY_DETAIL_RESPONSE>