fs-v4.0.qsd File Reference

provides access to the filesystem More...

Classes
class	QorusSystemService
	main fs service class More...

Detailed Description

provides access to the filesystem

The streams in the following table are provided.

Note

See Work with Data Streaming for easy to use functionality.

Supported Data Streams

Stream	Dir	HTTP Method	Args	Description
get-file	out	GET	path=string rename=string del=boolean timeout=ms [block=integer]	Reads a file and streams the raw data as binary data to the sender, where it can be converted to a string and encoded with a particular encoding if necessary. Requires FILESYSTEM-CONTROL or FILESYSTEM-READ permissions to access
get-xml-data	out	GET	path=string rename=string del=boolean element=string timeout=ms [encoding=string] [block=integer]	Reads an XML file and streams records to the sender. Requires FILESYSTEM-CONTROL or FILESYSTEM-READ permissions to access
get-csv-data	out	GET	path=string rename=string del=boolean timeout=ms [block=integer] csvutil=hash see CsvUtil::CsvFileIterator::constructor() for details the structure of this hash]	Reads a CSV or other structured data file parsable with CsvUtil::CsvFileIterator and streams records to the sender. Requires FILESYSTEM-CONTROL or FILESYSTEM-READ permissions to access
get-fixed-data	out	GET	path=string rename=string del=boolean timeout=ms [block=integer] fixedlengthutil=hash with "spec" and "opts" keys; see FixedLengthUtil::FixedLengthFileIterator::constructor() for details on the meanings of the values of these hash keys]	Reads a fixed-length file parsable with FixedLengthUtil::FixedLengthFileIterator and streams records to the sender. Requires FILESYSTEM-CONTROL or FILESYSTEM-READ permissions to access
put-file	in	POST	path=string timeout=ms [target_path=string] [mode=int] [encoding=string]	Accepts streamed string or binary data and writes the data to the given file