Last updated: 2018-01-16.
Copyright © Structured Concepts AB, all rights reserved.
Current API version: v0.1.
The file parser API was designed with ETL processing in mind. We needed a tool that would parse and, when necessary, repair text files with delimited or fixed-width data. The client can call the API using a custom application, web service calls from popular integration software like SSIS or Pentaho, or using a simple "curl" command.
The API uses an HTTPS POST operation. The exact URL contains information about the API version (optional) and the output format for the results.
The output format is declared in the URL. The following formats are available:
Once you have implemented a working solution, we recommend fixing the API version by declaring it in your API call. This provides a predictable output over time, even when newer versions of the API are deployed to the server.
To set a specific API version, include it in the POST URL, like this:
When you do not specify the API version, the most recent version available is used. The advantage is that you get the latest features and fixes, but your results may change over time as newer versions are released.
To use the most recent API version, leave it out of the POST URL, like this:
All parameters, except the output format and the API version, are sent as HTTP POST variables.
Contains the source file. The naming of the file is not significant and the same file name can be used simultaneously or repeatedly as many times as you need.
Specifies if the result is returned as a JSON blob or as raw data. When JSON is selected, the output is included in a JSON blob along with the log output. Then "plain" is chosen, the returned data will have a content type of "text/plain" or "text/html" depending on the output format chosen. Valid inputs are "plain" and "json" in lower case. If "output" is not specified, "json" is assumed.
Your organization's API key that allows you to parse full-size files. Note: without an API key, files are limited to 20 kB.
Specifies the maximum number of errors allowed. If the number of errors returned from the parsing exceeds this number, no result set will be returned to the client. Note that to see the errors, you will need to enable JSON output.
Applicable only when the SQL output format is chosen, this sets the fully qualified name of the output table used in the INSERT statements. If no table name is specified, the default name ###table### is used.
There are four parameters that control the detail of the output logs.