Skip to main content
. 2023 Jun 29;7:e44331. doi: 10.2196/44331

Table 2.

HTTP APIa end points that are required for the configuration optimization tool. All payloads and responses are formatted in JSON.

End point Functionality Payload Response
GET /matchConfig/:configId/spec Provide the specification of the configuration b A dictionary with root key “attributes,” which is a dictionary mapping each configuration parameter to a dictionary with a key “bounds” with its valid lower and upper bounds on its range.
GET /matchConfig/:configId Get the current configuration A dictionary with root key “attributes,” which is a dictionary mapping each configuration parameter to its float value.
PUT /matchConfig/:configId Set a new configuration A dictionary with root key “attributes,” which is a dictionary mapping each configuration parameter to its new value.
GET /matchConfig/:configId/$groundTruthScores Get the matching scores for a configuration A dictionary with 2 keys, “0” and “1.” “0” maps to a list of matching scores for record pairs that were deemed nonmatches by a human, and “1” maps to a list of matching scores for record pairs that were deemed matches by a human.

aAPI: application programming interface.

bNo payload or response.