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

Download Open API Spec

QueryBundleRequest

org.sagebionetworks.repo.model.table.QueryBundleRequest
Field Type Description
concreteType STRING
entityId STRING
query Query
partMask INTEGER Optional, default all. The 'partsMask' is an integer mask that can be combined into to request any desired part. The mask is defined as follows:
  • Query Results (queryResults) = 0x1
  • Query Count (queryCount) = 0x2
  • Select Columns (selectColumns) = 0x4
  • Max Rows Per Page (maxRowsPerPage) = 0x8
  • The Table Columns (columnModels) = 0x10
  • Facet statistics for each faceted column (facetStatistics) = 0x20
  • The sum of the file sizes (sumFileSizesBytes) = 0x40
  • The last updated on date (lastUpdatedOn) = 0x80
  • The combined SQL query including additional filters (combinedSql) = 0x100
  • The list of actions required for any file in the query(actionsRequired) = 0x200 (The query.selectFileColumn needs to be specified)