csvw-validator validating API API documentation version 1.0
APIs related to validating tabular data and metadata based on W3C CSV on the Web specification.
/validate
Validates one tabular data file and/or metadata file.
post /validate
Validates one tabular data file and/or metadata file.
Body
Media type: application/json
Type: object
Properties- tabularUrl: (string - maxLength: 300)
URL of tabular data file. Must be absolute URL with HTTP/HTTPS or file schema.
- metadataUrl: (string - maxLength: 300)
URL of metadata file. Must be absolute URL with HTTP/HTTPS or file schema.
- strictMode: (boolean)
If true, then strict mode is enabled for validating. By default it is true.
- language: (one of cs, en)
Language in which should be all error messages translated. Default language is 'en'.
HTTP status code 200
Input was successfully validated.
Body
Media type: application/json
Type: object
Properties- id: required(string - maxLength: 50)
Validation result identifier
- validationStatus: required(one of PASSED, WARNING, ERROR)
Result of the validation.
- tabularUrl: (string - maxLength: 300)
URL of inserted (and validated) tabular data file.
- metadataUrl: (string - maxLength: 300)
URL of inserted (and validated) metadata file.
- validationErrors: (array of ValidationError)
List of all validation errors.
Items: ValidationError
- severity: required(one of WARNING, ERROR, FATAL)
Severity of the error.
- WARNING - Some minor issue, which just creates warning.
- ERROR - Major error.
- FATAL - Major error, which is so important, that validating must be stopped.
- message: required(string - maxLength: 1000)
- severity: required(one of WARNING, ERROR, FATAL)
- warningCount: required(integer - minimum: 0)
Number of created warning errors in this validation.
- errorCount: required(integer - minimum: 0)
Number of created error errors in this validation.
- fatalCount: required(integer - minimum: 0)
Number of created fatal errors in this validation.
- totalErrorsCount: required(integer - minimum: 0)
Number of all created errors in this validation.
- rowsNumber: (integer - minimum: 0)
Total number of processed rows.
- columnsNumber: (integer - minimum: 0)
Total number of processed columns.
- tablesNumber: required(integer - minimum: 0)
Total number of processed tables.
HTTP status code 400
API entry validation error.
Body
Media type: application/json
Type: string
HTTP status code 500
Server error.
Body
Media type: application/json
Type: string
/validationResult/{resultId}
Return result of the validation.
get /validationResult/{resultId}
Return result of the validation.
URI Parameters
- resultId: required(string)
Id of the result.
HTTP status code 200
Result exist for the given id.
Body
Media type: application/json
Type: object
Properties- id: required(string - maxLength: 50)
Validation result identifier
- validationStatus: required(one of PASSED, WARNING, ERROR)
Result of the validation.
- tabularUrl: (string - maxLength: 300)
URL of inserted (and validated) tabular data file.
- metadataUrl: (string - maxLength: 300)
URL of inserted (and validated) metadata file.
- validationErrors: (array of ValidationError)
List of all validation errors.
Items: ValidationError
- severity: required(one of WARNING, ERROR, FATAL)
Severity of the error.
- WARNING - Some minor issue, which just creates warning.
- ERROR - Major error.
- FATAL - Major error, which is so important, that validating must be stopped.
- message: required(string - maxLength: 1000)
- severity: required(one of WARNING, ERROR, FATAL)
- warningCount: required(integer - minimum: 0)
Number of created warning errors in this validation.
- errorCount: required(integer - minimum: 0)
Number of created error errors in this validation.
- fatalCount: required(integer - minimum: 0)
Number of created fatal errors in this validation.
- totalErrorsCount: required(integer - minimum: 0)
Number of all created errors in this validation.
- rowsNumber: (integer - minimum: 0)
Total number of processed rows.
- columnsNumber: (integer - minimum: 0)
Total number of processed columns.
- tablesNumber: required(integer - minimum: 0)
Total number of processed tables.
HTTP status code 400
API entry validation error.
Body
Media type: application/json
Type: string
HTTP status code 404
Entity not found.
Body
Media type: application/json
Type: string
HTTP status code 500
Server error.
Body
Media type: application/json
Type: string
/validateBatch
Validates multiple tabular data files and/or metadata files.
post /validateBatch
Validates multiple tabular data files and/or metadata files.
Body
Media type: application/json
Type: object
Properties- filesToProcess: required(array of ProcessingInput)
Files to process.
Items: ProcessingInput
- tabularUrl: (string - maxLength: 300)
URL of tabular data file. Must be absolute URL with HTTP/HTTPS or file schema.
- metadataUrl: (string - maxLength: 300)
URL of metadata file. Must be absolute URL with HTTP/HTTPS or file schema.
- tabularUrl: (string - maxLength: 300)
- strictMode: (boolean)
If true, then strict mode is enabled for validating. By default it is true.
- language: (one of cs, en)
Language in which should be all error messages translated. Default language is 'en'.
- filesResults: (boolean)
If true, then response for this request will contains results for filesResults. Otherwise there will be just id of results. By default it is true.
HTTP status code 200
Inputs were successfully validated.
Body
Media type: application/json
Type: object
Properties- filesCount: required(integer - minimum: 0)
Number of validated files.
- passedFilesCount: required(integer - minimum: 0)
Number of files with ValidationStatus PASSED.
- warningFilesCount: required(integer - minimum: 0)
Number of files with ValidationStatus WARNING.
- errorFilesCount: required(integer - minimum: 0)
Number of files with ValidationStatus ERROR.
- filesResults: (array of ValidationResult)
Validation result for each file.
Items: ValidationResult
- id: required(string - maxLength: 50)
The validation result identifier.
- result: (object)
The validation result.
- id: required(string - maxLength: 50)
Validation result identifier
- validationStatus: required(one of PASSED, WARNING, ERROR)
Result of the validation.
- tabularUrl: (string - maxLength: 300)
URL of inserted (and validated) tabular data file.
- metadataUrl: (string - maxLength: 300)
URL of inserted (and validated) metadata file.
- validationErrors: (array of ValidationError)
List of all validation errors.
Items: ValidationError
- severity: required(one of WARNING, ERROR, FATAL)
Severity of the error.
- WARNING - Some minor issue, which just creates warning.
- ERROR - Major error.
- FATAL - Major error, which is so important, that validating must be stopped.
- message: required(string - maxLength: 1000)
- severity: required(one of WARNING, ERROR, FATAL)
- warningCount: required(integer - minimum: 0)
Number of created warning errors in this validation.
- errorCount: required(integer - minimum: 0)
Number of created error errors in this validation.
- fatalCount: required(integer - minimum: 0)
Number of created fatal errors in this validation.
- totalErrorsCount: required(integer - minimum: 0)
Number of all created errors in this validation.
- rowsNumber: (integer - minimum: 0)
Total number of processed rows.
- columnsNumber: (integer - minimum: 0)
Total number of processed columns.
- tablesNumber: required(integer - minimum: 0)
Total number of processed tables.
- id: required(string - maxLength: 50)
- id: required(string - maxLength: 50)
- strictMode: (boolean)
If true, then strict mode is enabled for validating. By default it is true.
- language: (one of cs, en)
Language in which should be all error messages translated.
HTTP status code 400
API entry validation error.
Body
Media type: application/json
Type: string
HTTP status code 500
Server error.
Body
Media type: application/json
Type: string