find_path* Flags
find_path_by_entity_id, find_path_by_record_id
These are the control flags applicable to:
- Python:
find_path_by_entity_id,find_path_by_record_id - Java:
findPathByEntityID,findPathByRecordID - sz_command:
findPathByEntityID,findPathByRecordID - C/C++:
Sz_findPathByEntityID,Sz_findPathByRecordID
find_path_by_entity_id, find_path_by_record_id methods use all of the flags available to getEntity*(), plus SZ_FIND_PATH_STRICT_AVOID and SZ_FIND_PATH_INCLUDE_MATCHING_INFO.
The default composite flag is SZ_FIND_PATH_DEFAULT_FLAGS.
SZ_FIND_PATH_DEFAULT_FLAGS
The output of SZ_FIND_PATH_DEFAULT_FLAGS is a composite of:
SZ_FIND_PATH_INCLUDE_MATCHING_INFOSZ_ENTITY_INCLUDE_ENTITY_NAMESZ_ENTITY_INCLUDE_RECORD_SUMMARY
{
"ENTITY_PATHS":
[
{
"START_ENTITY_ID": 100001,
"END_ENTITY_ID": 5,
"ENTITIES":
[
100001,
5
]
}
],
"ENTITY_PATH_LINKS":
[
{
"MIN_ENTITY_ID": 5,
"MAX_ENTITY_ID": 100001,
"MATCH_LEVEL_CODE": "POSSIBLY_RELATED",
"MATCH_KEY": "+ADDRESS+SURNAME",
"ERRULE_CODE": "CFF_SURNAME",
"IS_DISCLOSED": 0,
"IS_AMBIGUOUS": 0
}
],
"ENTITIES":
[
{
"RESOLVED_ENTITY":
{
"ENTITY_ID": 5,
"ENTITY_NAME": "Patricia Smith",
"RECORD_SUMMARY":
[
{
"DATA_SOURCE": "WATCHLIST",
"RECORD_COUNT": 1
}
]
}
},
{
"RESOLVED_ENTITY":
{
"ENTITY_ID": 100001,
"ENTITY_NAME": "Robert Smith",
"RECORD_SUMMARY":
[
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_COUNT": 4
}
]
}
}
]
}
SZ_FIND_PATH_INCLUDE_MATCHING_INFO
NOTE: The SZ_FIND_PATH_INCLUDE_MATCHING_INFO flag is dependent on using one of the following flags: SZ_ENTITY_INCLUDE_ALL_FEATURES, SZ_ENTITY_INCLUDE_REPRESENTATIVE_FEATURES, or SZ_ENTITY_INCLUDE_RECORD_FEATURE_IDS.
This sample response message was generated using SZ_FIND_PATH_INCLUDE_MATCHING_INFO and SZ_ENTITY_INCLUDE_RECORD_SUMMARY:
{
"ENTITY_PATHS":
[
{
"START_ENTITY_ID": 100001,
"END_ENTITY_ID": 5,
"ENTITIES":
[
100001,
5
]
}
],
"ENTITY_PATH_LINKS":
[
{
"MIN_ENTITY_ID": 5,
"MAX_ENTITY_ID": 100001,
"MATCH_LEVEL_CODE": "POSSIBLY_RELATED",
"MATCH_KEY": "+ADDRESS+SURNAME",
"ERRULE_CODE": "CFF_SURNAME",
"IS_DISCLOSED": 0,
"IS_AMBIGUOUS": 0
}
],
"ENTITIES":
[
{
"RESOLVED_ENTITY":
{
"ENTITY_ID": 5,
"RECORD_SUMMARY":
[
{
"DATA_SOURCE": "WATCHLIST",
"RECORD_COUNT": 1
}
]
}
},
{
"RESOLVED_ENTITY":
{
"ENTITY_ID": 100001,
"RECORD_SUMMARY":
[
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_COUNT": 4
}
]
}
}
]
}
SZ_FIND_PATH_STRICT_AVOID
NOTE: The SZ_FIND_PATH_STRICT_AVOID flag is dependent on using one of the following flags: SZ_ENTITY_INCLUDE_ALL_FEATURES, SZ_ENTITY_INCLUDE_REPRESENTATIVE_FEATURES, or SZ_ENTITY_INCLUDE_RECORD_FEATURE_IDS.
This sample response message was generated using SZ_FIND_PATH_DEFAULT_FLAGS and SZ_FIND_PATH_STRICT_AVOID:
{
"ENTITY_PATHS":
[
{
"START_ENTITY_ID": 100001,
"END_ENTITY_ID": 5,
"ENTITIES":
[
100001,
5
]
}
],
"ENTITY_PATH_LINKS":
[
{
"MIN_ENTITY_ID": 5,
"MAX_ENTITY_ID": 100001,
"MATCH_LEVEL_CODE": "POSSIBLY_RELATED",
"MATCH_KEY": "+ADDRESS+SURNAME",
"ERRULE_CODE": "CFF_SURNAME",
"IS_DISCLOSED": 0,
"IS_AMBIGUOUS": 0
}
],
"ENTITIES":
[
{
"RESOLVED_ENTITY":
{
"ENTITY_ID": 5,
"ENTITY_NAME": "Patricia Smith",
"RECORD_SUMMARY":
[
{
"DATA_SOURCE": "WATCHLIST",
"RECORD_COUNT": 1
}
]
}
},
{
"RESOLVED_ENTITY":
{
"ENTITY_ID": 100001,
"ENTITY_NAME": "Robert Smith",
"RECORD_SUMMARY":
[
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_COUNT": 4
}
]
}
}
]
}