Find and modify existing results based on this field's value.
Defaults to none
, meaning new results will be created.
If a key field is specified, AlisQI will try to find an existing result that matches the provided result's value for that field. If one is found, the existing result's values are merged with those provided and the result is modified. If no existing result is found, a new one is created.
You can prevent the creation of new results by setting editOnly=true
. When set, AlisQI will not create new results. Instead, an error message is provided for each result that has no matching existing result.
Use this to prevent accidental creation of results when key field values might not match up exactly.
Note that the key field evaluation is case sensitive.
When a key field is used, you only need to specify the values that you want to change. These will be merged with the existing values. That means you can even leave out values for required fields.
However, if no existing result is found, AlisQI will try to modify or create a result using only the partial result!
If you wish to remove a value, specify "field": null
in the Result.