DownloadFromTableRequest

org.sagebionetworks.repo.model.table.DownloadFromTableRequest

A CSV table download request.

Field Type Description
concreteType STRING
entityId STRING
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'.
csvTableDescriptor CsvTableDescriptor The description of a csv for upload or download.
sql STRING The SQL query string.
selectedFacets ARRAY<FacetColumnRequest> The selected facet filters.
includeEntityEtag BOOLEAN Optional, default false. When true, a query results against views will include the Etag of each entity in the results. Note: The etag is necessary to update Entities in the view.
isConsistent BOOLEAN Optional, default true. When true, a query will be run only if the index is up-to-date with all changes to the table and a read-lock is successfully acquired on the index. When set to false, the query will be run against the index regardless of the state of the index and without attempting to acquire a read-lock. When isConsistent is set to false the query results will not contain an etag so the results cannot be used as input to a table update.
offset INTEGER The optional offset into the results
limit INTEGER The optional limit to the results
sort ARRAY<SortItem>