API Docs / Schemas / CsvUploadResponseDto

CsvUploadResponseDto

Response from uploading a CSV file with showPreview=true.
Contains a preview of the CSV data and auto-suggested column mappings.
Use the code to call PUT /{code} to confirm mapping and start the import.

Properties

Name Type Description
codestring

Unique code identifying this import job.
Use this code to confirm and start the import via PUT /{code},
or to check status via GET /{code}.

Unique code identifying this import job.
Use this code to confirm and start the import via PUT /{code},
or to check status via GET /{code}.

hasHeaderRowboolean

Whether the first row was treated as column headers.
If hasHeaderRow was explicitly provided in the request, this reflects that value.
If not provided, this shows the auto-detected result based on the first row content.

Whether the first row was treated as column headers.
If hasHeaderRow was explicitly provided in the request, this reflects that value.
If not provided, this shows the auto-detected result based on the first row content.

headersarray of string

List of column headers detected from the CSV file.
If hasHeaderRow was true, these are from the first row.
If hasHeaderRow was false, these are auto-generated (Column1, Column2, etc.).

List of column headers detected from the CSV file.
If hasHeaderRow was true, these are from the first row.
If hasHeaderRow was false, these are auto-generated (Column1, Column2, etc.).

totalRowsinteger

Total number of data rows in the CSV file (excluding the header row if present).
This is the number of rows that will be processed during import.

Total number of data rows in the CSV file (excluding the header row if present).
This is the number of rows that will be processed during import.

previewRowsarray of object

Preview of the first few rows from the CSV file.
Each row is a dictionary mapping header names to cell values.
Use this to verify the data looks correct before confirming the import.
Typically includes up to 5 preview rows.

Preview of the first few rows from the CSV file.
Each row is a dictionary mapping header names to cell values.
Use this to verify the data looks correct before confirming the import.
Typically includes up to 5 preview rows.

suggestedMappingsarray of CsvColumnMappingDto

Auto-suggested column mappings based on header name matching.
The system attempts to match CSV headers to known target fields using fuzzy matching.
Review and adjust these mappings as needed when confirming the import.
Only includes mappings for headers that could be matched to target fields.

Auto-suggested column mappings based on header name matching.
The system attempts to match CSV headers to known target fields using fuzzy matching.
Review and adjust these mappings as needed when confirming the import.
Only includes mappings for headers that could be matched to target fields.

JSON Example

{
  "code": "string",
  "hasHeaderRow": false,
  "headers": [
    "string"
  ],
  "totalRows": 150,
  "previewRows": [
    {}
  ]
}

Used By Operations