find_path* Flags

find_path_by_entity_id, find_path_by_record_id

Searches for the shortest relationship path between two entities.

SDK Method
C# FindPath
Java findPath
Python find_path_by_entity_id , find_path_by_record_id

find_path_by_entity_id, find_path_by_record_id methods use all the get_entity*() flags , 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:

Click to expand response JSON Click to collapse 
{
  "ENTITY_PATHS": [
    {
      "START_ENTITY_ID": 1,
      "END_ENTITY_ID": 144,
      "ENTITIES": [1, 144]
    }
  ],
  "ENTITY_PATH_LINKS": [
    {
      "MIN_ENTITY_ID": 1,
      "MAX_ENTITY_ID": 144,
      "MATCH_LEVEL_CODE": "POSSIBLY_RELATED",
      "MATCH_KEY": "+ADDRESS+SURNAME",
      "ERRULE_CODE": "CFF_SURNAME",
      "IS_DISCLOSED": 0,
      "IS_AMBIGUOUS": 0
    }
  ],
  "ENTITIES": [
    {
      "RESOLVED_ENTITY": {
        "ENTITY_ID": 1,
        "ENTITY_NAME": "Robert Smith",
        "RECORD_SUMMARY": [
          {
            "DATA_SOURCE": "CUSTOMERS",
            "RECORD_COUNT": 4
          }
        ]
      }
    },
    {
      "RESOLVED_ENTITY": {
        "ENTITY_ID": 144,
        "ENTITY_NAME": "Patricia Smith",
        "RECORD_SUMMARY": [
          {
            "DATA_SOURCE": "WATCHLIST",
            "RECORD_COUNT": 1
          }
        ]
      }
    }
  ]
}

SZ_FIND_PATH_INCLUDE_MATCHING_INFO

Include matching info on entity paths for find-path functionality. The ENTITY_PATH_LINKS array will include MATCH_LEVEL_CODE, MATCH_KEY, ERRULE_CODE, IS_DISCLOSED, and IS_AMBIGUOUS for each link in the path.

This sample response message was generated using SZ_FIND_PATH_INCLUDE_MATCHING_INFO | SZ_ENTITY_INCLUDE_RECORD_SUMMARY :

Click to expand response JSON Click to collapse 
{
  "ENTITY_PATHS": [
    {
      "START_ENTITY_ID": 1,
      "END_ENTITY_ID": 144,
      "ENTITIES": [1, 144]
    }
  ],
  "ENTITY_PATH_LINKS": [
    {
      "MIN_ENTITY_ID": 1,
      "MAX_ENTITY_ID": 144,
      "MATCH_LEVEL_CODE": "POSSIBLY_RELATED",
      "MATCH_KEY": "+ADDRESS+SURNAME",
      "ERRULE_CODE": "CFF_SURNAME",
      "IS_DISCLOSED": 0,
      "IS_AMBIGUOUS": 0
    }
  ],
  "ENTITIES": [
    {
      "RESOLVED_ENTITY": {
        "ENTITY_ID": 1,
        "RECORD_SUMMARY": [
          {
            "DATA_SOURCE": "CUSTOMERS",
            "RECORD_COUNT": 4
          }
        ]
      }
    },
    {
      "RESOLVED_ENTITY": {
        "ENTITY_ID": 144,
        "RECORD_SUMMARY": [
          {
            "DATA_SOURCE": "WATCHLIST",
            "RECORD_COUNT": 1
          }
        ]
      }
    }
  ]
}

SZ_FIND_PATH_STRICT_AVOID

Indicate that avoided entities are not allowed under any circumstance — even if they are the only means by which a path can be found between two entities.

This sample response message was generated using SZ_FIND_PATH_STRICT_AVOID | SZ_FIND_PATH_DEFAULT_FLAGS :

Click to expand response JSON Click to collapse 
{
  "ENTITY_PATHS": [
    {
      "START_ENTITY_ID": 1,
      "END_ENTITY_ID": 144,
      "ENTITIES": [1, 144]
    }
  ],
  "ENTITY_PATH_LINKS": [
    {
      "MIN_ENTITY_ID": 1,
      "MAX_ENTITY_ID": 144,
      "MATCH_LEVEL_CODE": "POSSIBLY_RELATED",
      "MATCH_KEY": "+ADDRESS+SURNAME",
      "ERRULE_CODE": "CFF_SURNAME",
      "IS_DISCLOSED": 0,
      "IS_AMBIGUOUS": 0
    }
  ],
  "ENTITIES": [
    {
      "RESOLVED_ENTITY": {
        "ENTITY_ID": 1,
        "ENTITY_NAME": "Robert Smith",
        "RECORD_SUMMARY": [
          {
            "DATA_SOURCE": "CUSTOMERS",
            "RECORD_COUNT": 4
          }
        ]
      }
    },
    {
      "RESOLVED_ENTITY": {
        "ENTITY_ID": 144,
        "ENTITY_NAME": "Patricia Smith",
        "RECORD_SUMMARY": [
          {
            "DATA_SOURCE": "WATCHLIST",
            "RECORD_COUNT": 1
          }
        ]
      }
    }
  ]
}

If you have any questions, contact Senzing Support. Support is 100% FREE!