Description Usage Arguments Value
Replace all attributes of this Civis Data Match Enhancement
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
id |
integer required. The ID for the enhancement. |
name |
string required. The name of the enhancement job. |
input_field_mapping |
list required. The column mapping for the input table. See /enhancements/field_mapping for list of valid fields. |
input_table |
list required. A list containing the following elements:
|
match_target_id |
integer required. The ID of the Civis Data match target. See /match_targets for IDs. |
output_table |
list required. A list containing the following elements:
|
schedule |
list optional. A list containing the following elements:
|
parent_id |
integer optional. Parent ID that triggers this enhancement. |
notifications |
list optional. A list containing the following elements:
|
max_matches |
integer optional. The maximum number of matches per record in the input table to return. Must be between 0 and 10. 0 returns all matches. |
threshold |
number optional. The score threshold (between 0 and 1). Matches below this threshold will not be returned. |
archived |
boolean optional. Whether the Civis Data Match Job has been archived. |
A list containing the following elements:
id |
integer, The ID for the enhancement. |
name |
string, The name of the enhancement job. |
type |
string, The type of the enhancement (e.g CASS-NCOA) |
createdAt |
string, The time this enhancement was created. |
updatedAt |
string, The time the enhancement was last updated. |
author |
list, A list containing the following elements:
|
state |
string, The status of the enhancement's last run |
schedule |
list, A list containing the following elements:
|
parentId |
integer, Parent ID that triggers this enhancement. |
notifications |
list, A list containing the following elements:
|
runningAs |
list, A list containing the following elements:
|
inputFieldMapping |
list, The column mapping for the input table. See /enhancements/field_mapping for list of valid fields. |
inputTable |
list, A list containing the following elements:
|
matchTargetId |
integer, The ID of the Civis Data match target. See /match_targets for IDs. |
outputTable |
list, A list containing the following elements:
|
maxMatches |
integer, The maximum number of matches per record in the input table to return. Must be between 0 and 10. 0 returns all matches. |
threshold |
number, The score threshold (between 0 and 1). Matches below this threshold will not be returned. |
archived |
boolean, Whether the Civis Data Match Job has been archived. |
lastRun |
list, A list containing the following elements:
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.