Find Similar Web Services

Find Similar web services allow searching for potential duplicate records prior to creating new records, resulting in fewer duplicate objects in both source systems and STEP. Consider your requirements and then review the following table to determine the best way to implement Find Similar.

Complete documentation for web service functionality is at [system]/sdk or access the Technical Documentation button on the Start Page

 

getSimilarObjects

entities/find-similar

Web Service

Runs the match algorithm mentioned in the input record and outputs the found record or potential duplicates using the supplied XML output template.

Runs the match algorithm defined in the setup node and outputs the found record or potential duplicates using the XML output template defined in the endpoint setup node.

Setup

Core service, available at the same path on all systems.

Available if defined by Setup node in the System Setup.

API Style

SOAP

On Technical Documentation, access the 'Soap API documentation' link, and click the 'Core WebServices available in the STEP system' link to find details on:

  • getSimilarObjectsRequestType
  • getSimilarObjectsResponseType

REST

On Technical Documentation, access the link under the 'REST API V2' heading. Under the Entities section, click the POST button to find details and the 'Try it out' option for:

  • /entities/find-similar

Interfaces with

Web UI via:

  • Initiate Item Screen
  • Add Reverence Action

External services

Input

List of text strings which can be bound (via Node Binds) into the match algorithm, and then used as IDs for reference targets, attribute values, etc.

Entities - including data containers and references

Object Types allowed

All super types (refer to the Object Super Types topic in the Getting Started documentation here)

Entity

Matching Algorithm

Must include Node Binds for the input values. The same matching algorithm can be used for:

  • 'Duplicate Handler' on an 'Initiate Item' workflow screen in Web UI.
  • 'Find Similar' search on an 'Add Reference' action in Web UI.
  • 'GetSimilarObjects' SOAP web service request.

Standard matching algorithm

For more information

Refer to the getSimilarObjects in SOAP API topic here

Refer to the Find Similar in RESTv2 API topic here