Input Parameter Description
array of strings
An array of the file names to download from KiFS. File paths may contain wildcard characters after the KiFS directory delimiter.Accepted wildcard characters are asterisk (*) to represent any string of zero or more characters, and question mark (?) to indicate a single character.
array of longs
An array of starting byte offsets from which to read each respective file in input parameter file_names. Must either be empty or the same length as input parameter file_names. If empty, files are downloaded in their entirety. If not empty, input parameter read_lengths must also not be empty.
array of longs
Array of number of bytes to read from each respective file in input parameter file_names. Must either be empty or the same length as input parameter file_names. If empty, files are downloaded in their entirety. If not empty, input parameter read_offsets must also not be empty.
map of string to strings
Optional parameters.The default value is an empty map ( {} ).
Output Parameter Description
The Kinetica server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:String
‘OK’ or ‘ERROR’
String
Empty if success or an error message
String
‘download_files_response’ or ‘none’ in case of an error
String
Empty string
JSON or String
This embedded JSON represents the result of the /download/files endpoint:Empty string in case of an error.