CSV-validator API (1.0.2)

Download OpenAPI specification:Download

The API for the CSV-validator. More information at the Web Service documentation.

Validate

Starts validation for given files. More info [here

Starts validation for given files. More info here.

Request Body schema: application/json

metadataUrl	string <url>
tabularUrl	string <url>

Responses

Request samples

Payload

Content type

application/json

{"metadataUrl": "http://example.org/countries-metadata.json",
"tabularUrl": "http://example.org/countries.csv"
}

Response samples

200
400

Content type

application/json

{"resultID": 154678
}

ValidationResult

Retrieves a validation result based on ResultId. [

Retrieves a validation result based on ResultId. More info.

path Parameters

resultID

required

number

Example: 15467894

The ID of the validation result to retrieve

Responses

Response samples

200

Content type

application/json

{"ResultID": 7,
"ValidationStatus": "ERROR",
"ProgressStatus": "FINISHED",
"CreatedAt": "2024-03-28T18:13:52.8947799",
"TableGroupResult": {"TablesProcessed": 1,
"MetadataIRI": "https://w3c.github.io/csvw/tests/test279-metadata.json",
"GeneralErrors": [ ],
"GeneralWarnings": [ ],
"TableResults": [{"TableIRI": "https://w3c.github.io/csvw/tests/test279.csv",
"RowsProcessed": 1,
"ColumnsProcessed": 1,
"CellsProcessed": 1,
"NumberOfErrors": 1,
"NumberOfWarnings": 0,
"Errors": [{"Message": "There is datatype validation error!\r\nThe cell does not contain valid value of datatype specified in metadata file!\r\nTable url: https://w3c.github.io/csvw/tests/test279.csv\r\nCell row: 1 column: 1\r\nAdditional info: Foo\r\nMore about datatypes at:\r\nhttps://www.w3.org/TR/2015/REC-tabular-metadata-20151217/#datatypes"
}
],
"Warnings": [ ]
}
]
}
}