Entity Upload Configuration
A resource that represents the configuration of an entity upload. The upload configuration can be applied to files using the same template.
$idstring Required
$schemaconst Required
“https://schema.yext.com/config/km/entity-upload-config/v1" displayNamestring Required
The upload configuration display name.
mappingarray of object Required
List of mappings that associate a column from the uploaded file to a Yext field.
Must contain a minimum of 1 items
Each item of this array must be:
Mapping that associate a column from the uploaded file to a Yext field.
If the conditions in the “If” tab are respected, then the conditions in the “Then” tab should be respected. Otherwise, the conditions in the “Else” tab should be respected.
const
false The following properties are required:
- sourceColumnName
- fieldReference
- transform
The following properties are required:
- sourceColumnName
string
Uploaded file column header name.
boolean
If set to true, all values of the column will be omitted.
object
Yext field reference.
string Required
Yext field resource ID.
array of string
Yext field property names to reference Yext sub-field.
Each item of this array must be:
Yext field property name.
array
Transformations to apply during the upload process.
Each item of this array must be:
Transformations without configurations.
enum (of string)
Transformation type. TRIMWHITESPACE will remove the leading and trailing white spaces; ADDTOEXISTING will append uploaded value to existing values; INFERPHONEISOCOUNTRYCODE will infer uploaded phone number to ISO country code; PHONELETTERSTONUMBERS will convert phone letters to numbers.
Must be one of:
- “TRIM_WHITESPACE”
- “ADD_TO_EXISTING”
- “INFER_PHONE_ISO_COUNTRY_CODE”
- “PHONE_LETTERS_TO_NUMBERS”
Uploaded value capitalization transformation.
const
Transformation type.
Specific value:“CAPITALIZE” object Required
Capitalized transformation configurations.
enum (of string) Required
CAPITALIZE capitalizes all the delimiter separated words in a String; CAPITALIZE_FULLY converts all the whitespace separated words in a String into capitalized words, that is each word is made up of a titlecase character and then a series of lowercase characters.
Must be one of:
- “CAPITALIZE”
- “CAPITALIZE_FULLY”
Handle blank uploaded value operation.
const
Transformation type.
Specific value:“HANDLE_BLANK_VALUES” object Required
Handle blank value transformation configuration.
enum (of string) Required
IGNORE will disregard the uploaded blank value; CLEAR will clear the value from the specified field reference
Must be one of:
- “IGNORE”
- “CLEAR”
Uploaded list value delimitation transformation.
const
Transformation type.
Specific value:“DELIMITED_COLUMNS” object Required
enum (of string) Required
COMMA will delimit value into a list by commas; TAB will delimit value into a list by tabs.
Must be one of:
- “COMMA”
- “TAB”
Uploaded rich text value transformations.
const
“RICH_TEXT_FORMATTING_TYPE” object
Transformation type.
enum (of string) Required
ALLOWSUPPORTEDFORMATTING converts uploaded data into supported rich text formats; REMOVEALLFORMATTING strips out all formatting syntax in uploaded data.
Must be one of:
- “ALLOW_SUPPORTED_FORMATTING”
- “REMOVE_ALL_FORMATTING”
enum (of string) Required
Uploaded rich text data format language.
Must be one of:
- “MARKDOWN”
- “HTML”
Uploaded time zone value transformations.
const
Transformation type.
Specific value:“TIME_ZONE_FORMATTING_TYPE” object Required
enum (of string) Required
IANA allows time zone in IANA format, e.g., ‘America/NewYork’; GMTOFFSET allows time zone in GMT_OFFSET format, e.g., ‘(GMT-4) New York Time’.
Must be one of:
- “IANA”
- “GMT_OFFSET”
additionalFieldarray of object
List of additional data to add to the upload.
Each item of this array must be:
An additional data to add to the upload.
enum (of string) Required
The scope of the entities to include additional data. ALL is all entities for the business; NEW is newly created entities through the current upload process; EXISTING is all the existing entities specified in the file.
Must be one of:
- “ALL”
- “NEW”
- “EXISTING”
object Required
Yext field reference.
Same definition as mapping_items_fieldReferencestring Required
The value of the additional data.
array Required
Transformations to apply during the upload process.
Each item of this array must be:
Transformations without configurations.
Same definition as mapping_items_transform_items_oneOf_i0Uploaded value capitalization transformation.
Same definition as mapping_items_transform_items_oneOf_i1Handle blank uploaded value operation.
Same definition as mapping_items_transform_items_oneOf_i2Uploaded list value delimitation transformation.
Same definition as mapping_items_transform_items_oneOf_i3Uploaded rich text value transformations.
Same definition as mapping_items_transform_items_oneOf_i4Uploaded time zone value transformations.
Same definition as mapping_items_transform_items_oneOf_i5actionarray
Additional operations to apply with this upload.
Each item of this array must be:
Additional operation to apply with this upload.
object Required
The scope of the entities to apply the additional action. ALL is all entities for the business; MISSING is existing entities not specified in the uploaded file; NEW is newly created entities through the current upload process; EXISTING is all the existing entities specified in the file.
Must be one of:
- “ALL”
- “MISSING”
- “NEW”
- “EXISTING”
const Required
Additional action type.
Specific value:“ADD_LABEL” object Required
Add label configuration.
string Required
Label resource id.
object Required
The scope of the entities to apply the additional action. ALL is all entities for the business; MISSING is existing entities not specified in the uploaded file; NEW is newly created entities through the current upload process; EXISTING is all the existing entities specified in the file.
Same definition as action_items_oneOf_i0_entityClassificationconst Required
Additional action type.
Specific value:“APPLY_TEMPLATE” object Required
Apply template configuration.
string Required
Template resource id.
object Required
The scope of the entities to apply the additional action. ALL is all entities for the business; MISSING is existing entities not specified in the uploaded file; NEW is newly created entities through the current upload process; EXISTING is all the existing entities specified in the file.
Same definition as action_items_oneOf_i0_entityClassificationconst Required
Additional action type.
Specific value:“MOVE_TO_FOLDER” object Required
Move to folder configuration.
string Required
Folder resource id.