Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagejson
{
	"properties": {
		"query": {
			"$ref": "org.sagebionetworks.repo.model.table.Query"
		},
		"partMask": {
			"type": "integer",
			"description": "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:<ul><li>Query Results <i>(queryResults)</i> = 0x1</li><li>Query Count <i>(queryCount)</i> = 0x2</li><li>Select Columns <i>(selectColumns)</i> = 0x4</li><li>Max Rows Per Page <i>(maxRowsPerPage)</i> = 0x8</li><li>The Table Columns <i>(columnModels)</i> = 0x10</li><li>Facet statistics for each faceted column <i>(facetStatistics)</i> = 0x20</li><li>The sum of the file sizes <i>(sumFileSizesBytes)</i> = 0x40</li><li>The last updated on date <i>(lastUpdatedOn)</i> = 0x80</li><li>The combined SQL query including additional filters <i>(combinedSql)</i> = 0x100</li><li>The list of actions required for any file in the query<i>(actionsRequired)</i> = 0x200 (The query.selectFileColumn needs to be specified)</li></ul>"
		},
		"includeFacetStatsFor": {
			"description": "Optional. When partMask is set to include facet statistics (0x20), use this to limit which facet columns should return facet statistics.  Each value should be the name of a facet column for which the facet statistics should be returned in the query results.  When empty, or excluded, all faceted columns statistics will be returned (when partMask=0x20).",
			"type": "array",
			"items": {
				"type": "object",
				"properties": {
					"columnName": {
						"type": "string",
						"description": "The column name of the facet."
						"required": "true"
					},
					"jsonPath": {
						"type": "string"
						"description": "The optional JSON Path, which should be provided for JSON column facets",
						"required": "false"
					}
				}
			}
		}
	}
}