Importing CSV files
The import commands for CSV files must have the mandatory operation fields and identifier requirements as the import commands. The difference is that the JSON template contains placeholders for the data that must be retrieved from the CSV file:
Example ${n}
, where n represents the number of the table column.
Note The first column is 1.
You can use a combination of placeholders and hard-coded values in the JSON template.
JSON template structure |
---|
|
CSV parameters
Parameter | Description | Default value |
---|---|---|
template | The JSON template used to interpret CSV or Excel data. Mandatory. | |
separator | The delimiter character used to separate entries. | ; |
quote | The delimiter character used for quoted entries. | " |
escape | The delimiter character used to escape separator or quote character. | \ |
strictQuotes | Whether the characters outside quotes should be ignored. | false |
ignoreLeadingWhitespace | Whether whitespace characters before quotes should be ignored. | false |
headerRow | Whether the first row of the imported CSV file is the header. | false |
Multivalue separator and quote characters
Use the multivalue separator and quote characters when you import multiple values from the same column or the same line of your CSV file.
You can import multiple values from the same column, in an array, indicated by a placeholder enclosed in square brackets in your JSON template:
Example ["${n}"]
If you use the default API request field separator (;
), the multivalue separator is ,
. Otherwise, the multivalue separator is ;
.
For the default API request field separator parameter, the third column in the following CSV example contains two values: C
and D
.
A;B;C,D
If you use the default API request quote ("
), the multivalue quote is |
. Otherwise, the multivalue quote is "
.
For the default values for the API request quote parameter, the third column in the following CSV example contains one value: C,D
.
A;B;|C,D|
You can import multiple resources from the same row, in an array, indicated by the import command enclosed in square brackets:
For the default values for the API request separator parameter, the following combination of CSV and import template upserts two assets: A
and B
.
Name;Domain;Community;Asset Type
A,B;New Business Terms;Data Governance Council;Business Term
[
[
{
"resourceType": "Asset",
"identifier": {
"name": "${1}",
"domain": {
"name": "${2}",
"community": {
"name": "${3}"
}
}
},
"type": {
"name": "${4}"
}
}
]
]
The escape character
You can use an escape character to have the Import API treat the following special characters as normal characters when they are part of the values you are importing:
- Separator characters
- Quote characters
- Escape characters
The default escape character is \
.
For single value columns and rows, use one escape character before the special character you want to escape:
CSV value | Escaped special character | Imported value |
---|---|---|
C\;D
|
Default separator character: ; |
C;D |
\"CD\"
|
Default quote character: " |
"CD" |
C\\D
|
Default escape character: \ |
C\D |
For multivalue columns and rows, use two escape characters before the special character you want to escape:
CSV value | Escaped special character | Imported value |
---|---|---|
C\\,D
|
Default multivalue separator character: , |
C,D |
\\|CD\\|
|
Default multivalue quote character: | |
|CD| |
C\\\D
|
Default escape character: \ |
C\D |