Support DESK

Follow

H5.3.8 - Lookup

Previous Article matchIT Hub Index Next Article 

Resources relative to http://host:8080/matchITHub/engines/<engine>

REST resource Summary
POST lookup Look up a record.
Form data: data=<data>
recordLimit=<recordLimit>
minimumScore=<minimumScore>
timeout=<timeout>
GET tables/1/?data=<data> Same as lookup
POST lookup Look up a record.
Json: data={<json query>}

POST /matchITHub/engines/<engine>/lookup data=<data>, recordLimit=<recordLimit>, minimumScore=<minimumScore>, timeout=<timeout>

Request

Type Name Description
PathParam engine The id of the engine to modify
FormParam data A data record to lookup
FormParam recordLimit Maximum number of results to return (default 0 - no limit)
FormParam minimumScore Minimum score of results to return (default 0)
FormParam timeout Timeout in milliseconds (default 1000)

Response

Name Value Description
count <count> Count of results
result <result records> Array of result records

Description

Equivalent to adding data to table 2 and repeatedly calling RESULTS/NEXT.

If it fails to lock the engine for timeout milliseconds you may get some empty strings in the results.

The count in the response is the number of matches that matchIT Hub found. If I record limit was specified the result array may contain fewer records.

GET /matchITHub/engines/<engine>/tables/1?data=<data>, recordLimit=<recordLimit>, minimumScore=<minimumScore>

Request

Type Name Description
PathParam engine The id of the engine to modify
QueryParam data A data record to lookup
QueryParam recordLimit Maximum number of results to return (default 0 - no limit)
QueryParam minimumScore Minimum score of results to return (default 0)
QueryParam timeout Timeout in milliseconds (default 1000)

Response

Name Value Description
count <count> Count of results
result <result records> Array of result records

Description

Same as POST lookup. Equivalent to adding data to table 2 and repeatedly calling RESULTS/NEXT.

E.g.

GETlookup.png

POST /matchITHub/engines/<engine>/lookup data=<json query>

From version 2.0.4.

Request

Type Name Description
PathParam engine The id of the engine to modify
JsonParam data A json query

Response

Name Value Description
count <count> Count of results
result <result records> Array of result records

Description

Alternative version of POST lookup that takes json as input rather than form data. In the post header specify Content-Type: application/json rather than Content-Type: multipart/form-data

The json query can contain any of the column types specified in Configuration Guide - Appendix A - Column Types and the following:

Name Description
recordLimit Maximum number of results to return (default 0 - no limit)
minimumScore Minimum score of results to return (default 0)
timeout Timeout in milliseconds (default 1000)
ruleSet see Configuration Guide - Matching Rule Sets

 

Previous Article matchIT Hub Index Next Article 
Was this article helpful?
0 out of 0 found this helpful

0 Comments

Please sign in to leave a comment.