Download OpenAPI specification:
Creates a Config object.
|
required
|
object
(SplinkSettings)
|
|
potential_match_threshold
required
|
number
<double>
[ 0 .. 1 ]
|
|
auto_match_threshold
required
|
number
<double>
[ 0 .. 1 ]
|
{
-
"splink_settings":
{
-
"probability_two_random_records_match":
1,
-
"em_convergence":
0.1,
-
"max_iterations":
1,
-
"blocking_rules_to_generate_predictions":
[
-
{
-
"blocking_rule":
"string"
}
],
-
"comparisons":
[
-
{
-
"output_column_name":
"string",
-
"comparison_description":
"string",
-
"comparison_levels":
[
-
{
-
"sql_condition":
"string",
-
"label_for_charts":
"string",
-
"is_null_level":
false,
-
"m_probability":
1,
-
"u_probability":
1,
-
"tf_adjustment_column":
"string",
-
"tf_adjustment_weight":
0.1
}
]
}
]
},
-
"potential_match_threshold": 1,
-
"auto_match_threshold": 1
}
{
-
"config_id":
"string"
}
Create a person record match.
|
potential_match_id
required
|
string
|
|
potential_match_version
required
|
integer
|
|
required
|
Array of objects
(PersonUpdate)
|
|
Array of objects
(PersonRecordComment)
|
{
-
"potential_match_id":
"string",
-
"potential_match_version": 0,
-
"person_updates":
[
-
{
-
"id":
"string",
-
"version":
0,
-
"new_person_record_ids":
[
-
"string"
]
}
],
-
"comments":
[
-
{
-
"person_record_id":
"string",
-
"comment":
"string"
}
]
}
{ }
Import person records from an S3 object.
|
s3_uri
required
|
string
|
|
config_id
required
|
string
|
{
-
"s3_uri":
"string",
-
"config_id":
"string"
}
{
-
"job_id":
"string"
}
{
-
"person":
{
-
"id":
"string",
-
"created":
"2019-08-24T14:15:22Z",
-
"version":
0,
-
"records":
[
-
{
-
"id":
"string",
-
"person_id":
"string",
-
"created":
"2019-08-24T14:15:22Z",
-
"person_updated":
"2019-08-24T14:15:22Z",
-
"matched_or_reviewed":
true,
-
"data_source":
"string",
-
"source_person_id":
"string",
-
"first_name":
"string",
-
"last_name":
"string",
-
"sex":
"string",
-
"race":
"string",
-
"birth_date":
"string",
-
"death_date":
"string",
-
"social_security_number":
"string",
-
"address":
"string",
-
"city":
"string",
-
"state":
"string",
-
"zip_code":
"string",
-
"county":
"string",
-
"phone":
"string"
}
]
}
}
Get PotentialMatch by ID.
|
id
required
|
string
|
{
-
"potential_match":
{
-
"id":
"string",
-
"first_name":
"string",
-
"last_name":
"string",
-
"data_sources":
[
-
"string"
],
-
"max_match_probability":
0.1,
-
"results":
[
-
{
-
"id":
"string",
-
"created":
"2019-08-24T14:15:22Z",
-
"match_probability":
0.1,
-
"person_record_l_id":
"string",
-
"person_record_r_id":
"string"
}
],
-
"persons":
[
-
{
-
"id":
"string",
-
"created":
"2019-08-24T14:15:22Z",
-
"version":
0,
-
"records":
[
-
{
-
"id":
"string",
-
"person_id":
"string",
-
"created":
"2019-08-24T14:15:22Z",
-
"person_updated":
"2019-08-24T14:15:22Z",
-
"matched_or_reviewed":
true,
-
"data_source":
"string",
-
"source_person_id":
"string",
-
"first_name":
"string",
-
"last_name":
"string",
-
"sex":
"string",
-
"race":
"string",
-
"birth_date":
"string",
-
"death_date":
"string",
-
"social_security_number":
"string",
-
"address":
"string",
-
"city":
"string",
-
"state":
"string",
-
"zip_code":
"string",
-
"county":
"string",
-
"phone":
"string"
}
]
}
]
}
}
Update User role.
|
id
required
|
string
|
|
user_id
required
|
string
|
|
required
|
(RoleEnum (string or null)) or (NullEnum (any or
null))
|
{
-
"user_id":
"string",
-
"role":
"admin"
}
{
-
"user":
{
-
"id":
"string"
}
}