Comment on page

Upload

List
{
    "kind": "upload",
    "uri": string,
    "url": string,
    "id": integer,
    "name": string,
    "status": string("queued","running","completed","failed"),
    "hash": string,
    "size": integer,
    "numRows": integer,
    "numBytes": integer,
}
Get
In addition to the base definition, any upload resource returned by a get request will contain the following properties:
{
    "type": string,
    "hasHeaderRow": bool,
    "delimiter": string,
    "quoteCharacter": string,
    "escapeCharacter": string,
    "skipBadRecords": bool,
    "badRecordsCount": integer,
    "hasQuotedNewlines": bool,
    "errorMessage": string
}
Documentation
field
​
List
​
kind
string
The resource type. Will always be "variable".
uri
string
The fully qualified reference to this upload, for use in generating calls to this API. 
For example, /tables/imathews.example:123.test:456/uploads/789
url
string
The qualified URL to the upload
id
integer
The unique identifier for the upload
name
string
The name of the file. Defaults to untitled_upload.{type}
status
string
The current import status of the upload. Will be one of "queued", "running", "completed", "failed"
hash
string
The md5 hash of the upload's file content.
size
integer
The size, in bytes, of the uploaded file..
numRows
integer
The number of rows in the uploaded content
numBytes
integer
The number of bytes stored in Redivis's tabular representation of the upload. This will likely be different than size, which reflects the number of bytes in the file that was uploaded.
Get
​
type
string
The type of file being uploaded. Will be one of: 
delimited
stream 
avro
ndjson
parquet
orc
xls
xlsx
dta
sas7bdat
sav
geojson
geojsonl
json
shp
shp.zip
kml
hasHeaderRow
boolean
Whether the first row contains a list of variable names. Defaults to true. Only relevant for types csv,xls,xlsx
delimiter
string
The delimiter used to separate cells in file. Only relevant for type csv. If null (the default), the delimiter will be auto-computed based on an analysis of a preview of the file.
quoteCharacter
string
The quote sequence used to escape cells in a csv , not relevant for other types. Defaults to ". In order to escape a quote character, it must be doubled — e.g.:
"She said, ""Hello"""
escapeCharacter
string
The escape characters specifies the character that indicates characters immediately following it should be escaped. Defaults to the quoteCharacter (described above)
allowJaggedRows
boolean
Whether to allow rows that have more or fewer columns than the header row. Use caution when setting to true, as jagged rows often suggest a parsing issue; ignoring those errors could lead to data corruption.
skipBadRecords
boolean
Defaults to false. If true, upload will succeed even if some records cannot be parsed.
hasQuotedNewlines
boolean
Whether  newline characters exist in cells. Only relevant for types csv | ndjson | xls | xlsx | dta | sas7bdat | sav. 
errorMessage
string
If status == "failed", will provide additional information about what cause the upload failure.
​

Resource definitions - Previous

Query

Next - Resource definitions

User

Last modified 1yr ago

field
List
kind	string The resource type. Will always be "variable".
uri	string The fully qualified reference to this upload, for use in generating calls to this API. For example, `/tables/imathews.example:123.test:456/uploads/789`
url	string The qualified URL to the upload
id	integer The unique identifier for the upload
name	string The name of the file. Defaults to `untitled_upload.{type}`
status	string The current import status of the upload. Will be one of `"queued", "running", "completed", "failed"`
hash	string The md5 hash of the upload's file content.
size	integer The size, in bytes, of the uploaded file..
numRows	integer The number of rows in the uploaded content
numBytes	integer The number of bytes stored in Redivis's tabular representation of the upload. This will likely be different than `size`, which reflects the number of bytes in the file that was uploaded.
Get
type	string The type of file being uploaded. Will be one of: delimited stream avro ndjson parquet orc xls xlsx dta sas7bdat sav geojson geojsonl json shp shp.zip kml
hasHeaderRow	boolean Whether the first row contains a list of variable names. Defaults to `true`. Only relevant for types `csv`,`xls`,`xlsx`
delimiter	string The delimiter used to separate cells in file. Only relevant for type `csv`. If `null` (the default), the delimiter will be auto-computed based on an analysis of a preview of the file.
quoteCharacter	string The quote sequence used to escape cells in a `csv` , not relevant for other types. Defaults to `"`. In order to escape a quote character, it must be doubled — e.g.: `"She said, ""Hello"""`
escapeCharacter	string The escape characters specifies the character that indicates characters immediately following it should be escaped. Defaults to the `quoteCharacter` (described above)
allowJaggedRows	boolean Whether to allow rows that have more or fewer columns than the header row. Use caution when setting to true, as jagged rows often suggest a parsing issue; ignoring those errors could lead to data corruption.
skipBadRecords	boolean Defaults to `false`. If true, upload will succeed even if some records cannot be parsed.
hasQuotedNewlines	boolean Whether newline characters exist in cells. Only relevant for types `csv \| ndjson \| xls \| xlsx \| dta \| sas7bdat \| sav`.
errorMessage	string If `status == "failed"`, will provide additional information about what cause the upload failure.