Get a CASS/NCOA Enhancement
enhancements_get_cass_ncoa(id)
| id | integer required. |
|---|
A list containing the following elements:
integer, The ID for the enhancement.
string, The name of the enhancement job.
string, The type of the enhancement (e.g CASS-NCOA)
string, The time this enhancement was created.
string, The time the enhancement was last updated.
list, A list containing the following elements:
id integer, The ID of this user.
name string, This user's name.
username string, This user's username.
initials string, This user's initials.
online boolean, Whether this user is online.
string, The status of the enhancement's last run
list, A list containing the following elements:
scheduled boolean, If the item is scheduled.
scheduledDays array, Day based on numeric value starting at 0 for Sunday.
scheduledHours array, Hours of the day it is scheduled on.
scheduledMinutes array, Minutes of the day it is scheduled on.
scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour.
integer, Parent ID that triggers this enhancement.
list, A list containing the following elements:
urls array, URLs to receive a POST request at job completion
successEmailSubject string, Custom subject line for success e-mail.
successEmailBody string, Custom body text for success e-mail, written in Markdown.
successEmailAddresses array, Addresses to notify by e-mail when the job completes successfully.
successEmailFromName string, Name from which success emails are sent; defaults to "Civis."
successEmailReplyTo string, Address for replies to success emails; defaults to the author of the job.
failureEmailAddresses array, Addresses to notify by e-mail when the job fails.
stallWarningMinutes integer, Stall warning emails will be sent after this amount of minutes.
successOn boolean, If success email notifications are on.
failureOn boolean, If failure email notifications are on.
list, A list containing the following elements:
id integer, The ID of this user.
name string, This user's name.
username string, This user's username.
initials string, This user's initials.
online boolean, Whether this user is online.
list, A list containing the following elements:
databaseTable list . A list containing the following elements:
schema string, The schema name of the source table.
table string, The name of the source table.
remoteHostId integer, The ID of the database host for the table.
credentialId integer, The id of the credentials to be used when performing the enhancement.
multipartKey array, The source table primary key.
list, A list containing the following elements:
databaseTable list . A list containing the following elements:
schema string, The schema name for the output data.
table string, The table name for the output data.
list, A list containing the following elements:
address1 string, The first address line.
address2 string, The second address line.
city string, The city of an address.
state string, The state of an address.
zip string, The zip code of an address.
name string, The full name of the resident at this address. If needed, separate multiple columns with `+`, e.g. `first_name+last_name`
company string, The name of the company located at this address.
boolean, Defaults to true, where the existing column mapping on the input table will be used. If false, a custom column mapping must be provided.
boolean, Whether to update addresses for records matching the National Change of Address (NCOA) database.
integer, Credential to use when performing NCOA updates. Required if 'performNcoa' is true.
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.
string, The limiting SQL for the source table. "WHERE" should be omitted (e.g. state='IL').
string, The archival status of the requested item(s).