The Open API specification for Synapse is now available for download!

Download Open API Spec

DownloadFromGridRequest

org.sagebionetworks.repo.model.grid.DownloadFromGridRequest

A CSV Grid download request.

Field Type Description
concreteType STRING
sessionId STRING The grid session ID.
writeHeader BOOLEAN Should the first line contain the columns names as a header in the resulting file? Set to 'true' to include the headers else, 'false'. The default value is 'true'.
includeRowIdAndRowVersion BOOLEAN Should the first two columns contain the row ID and row version? The default value is 'true'.
includeEtag BOOLEAN Should the first (or third if includeRowIdAndRowVersion is true) column contain the row etag? The default value is 'true'.
csvTableDescriptor CsvTableDescriptor The description of a csv for upload or download.
fileName STRING The optional name for the downloaded table.