Versions Compared

Old Version 3

changes.mady.by.user Sophia

Saved on

compared with

New Version 4

changes.mady.by.user Sophia

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Section
borderfalse
Column
width60%

String Comparator Resource

 

Table of Contents

URL: /openempi-ws-rest/1.0/string-comparators

Method

GET

Returns the list of string comparators that the instance supports.

Responses

  • 200 - application/json - Returns a JSON representation of the response based on the Accept header

  • 200 - application/xml - Returns an XML representation of the response based on the Accept header

  • 404 - Returned if there is no known comparator on the instance (should never be the case)

Example

Version 1.0

http://localhost:8080/openempi-admin/openempi-ws-rest/1.0/string-comparators

Content-TypeAccept: applicaton/json

Return:

Code Block
languagejs
{
    "data": [
        "Exact",
        "Jaro",
        "JaroWinkler",
        "JaroWinklerV2",
        "Levenshtein",
        "NeedlemanWunsch",
        "SmithWaterman",
        "MongeElkan",
        "Gotoh",
        "GotohWindowedAffine",
        "Block",
        "Soundex",
        "Euclidean",
        "QGrams",
        "JaccardString",
        "Cosine",
        "DiceString",
        "Matching",
        "Overlap",
        "RegularExpression",
        "Numeric",
        "Date"
    ]
}

 


URL: /openempi-ws-rest/1.0/

records/findByIdentifier

string-comparators/{comparator}/parameters

 

Parameters

entityIdIntegerQuery unique identifier of the entity type whose records are queried

Parameter

Value Type

Parameter Type

R/O

Description

comparatorStringPath ParameterRThe
firstResultIntegerQuery ParameterOThe number of records to skip before the first result record
maxResultsIntegerQuery ParameterOThe maximum number of records that should be returned
ketValString of Key, Value pairQuery ParameterRThe key value pair that will be used to constrain the set of results returned. This is a repeating parameter and the value of the parameter will be coerced into the datatype of the attribute identified by the keyname of the string comparator for which you want to retrieve the list of parameters.

GET

Returns the list of parameters if any that the string comparator specified in the path requires. The name of the string comparator must be one of the supported string comparators on the instance.

Responses

  • 200 - application/json - Returns a JSON representation of the response based on the Accept header

  • 200 - application/xml - Returns an XML representation of the response based on the Accept header

  • 404 - Returned if there are no required parameters for the comparator.

Example

Version 1.0

http://localhost:8080/openempi-admin/openempi-ws-rest/1.0/string-comparators/RegularExpression/parameters

Accept: applicaton/xml

Code Block
languagexml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<stringList>
    <data>regular-expression</data>
</stringList>

 

 

Column
width40%