Queue validation for CSV import

You call thislegacyreportui

POST

/v1/import/validation/{importDefinitionId}

const url = 'https://api.zentail.com/v1/import/validation/example';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.zentail.com/v1/import/validation/example \
  --header 'Authorization: Bearer <token>'

This creates a validation for the given import definition. It queues it to be run for the given CSV file. GET /import/validation/results can be used to check the progress and current results.

Authorizations

zentail_oauth
legacy
zentail_oauth
report
zentail_oauth
ui
zentail_auth

Parameters

Path Parameters

importDefinitionId

required

string

The import definition ID is an ID that is unique for every definition of a report type and consists of the import type, the integration ID if applicable, and the template ID if applicable. The three parts are joined by semicolons: <type>:<integration ID>:<template ID> (e.g. “TemplatelessProduct::”, “TemplatedProduct::35”, “FullProductData:4:”, “Kits::”)

Responses

200

Success

*/*

object

import_validation_id

number

supplied_headers

Array<string>

actual_headers

Array<string>

first_10_rows

Array<Array<string>>

400

Bad Request

*/*

object

errorCode

number

Example

errorMessages

Array<string>

referenceId

string format: uuid

403

Permission Denied

*/*

object

errorCode

number

Example

errorMessages

Array<string>

referenceId

string format: uuid

404

Not Found

*/*

object

errorCode

number

Example

errorMessages

Array<string>

referenceId

string format: uuid

500

Zentail Error

*/*

object

errorCode

number

Example

errorMessages

Array<string>

referenceId

string format: uuid

errorMessage

string

503

Zentail Error

*/*

object

errorCode

number

Example

errorMessages

Array<string>

referenceId

string format: uuid

API changelog