| tables_get_enhancements_cass_ncoa {civis} | R Documentation |
View the status of a CASS / NCOA table enhancement
Description
View the status of a CASS / NCOA table enhancement
Usage
tables_get_enhancements_cass_ncoa(id, source_table_id)
Arguments
id |
integer required. The ID of the enhancement. |
source_table_id |
integer required. The ID of the table that was enhanced. |
Value
A list containing the following elements:
id |
integer, The ID of the enhancement. |
sourceTableId |
integer, The ID of the table that was enhanced. |
state |
string, The state of the enhancement, one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'. |
enhancedTableSchema |
string, The schema name of the table created by the enhancement. |
enhancedTableName |
string, The name of the table created by the enhancement. |
performNcoa |
boolean, Whether to update addresses for records matching the National Change of Address (NCOA) database. |
ncoaCredentialId |
integer, Credential to use when performing NCOA updates. Required if 'performNcoa' is true. |
outputLevel |
string, The set of fields persisted by a CASS or NCOA enhancement.For CASS enhancements, one of 'cass' or 'all.'For NCOA enhancements, one of 'cass', 'ncoa' , 'coalesced' or 'all'.By default, all fields will be returned. |
batchSize |
integer, The maximum number of records processed at a time. Note that this parameter is not available to all users. |