DownloadPFBRequest
org.sagebionetworks.repo.model.table.DownloadPFBRequest
Request to download a Portable Format for Biomedical (PFB) file from a a table/view query result.
| Field | Type | Description |
|---|---|---|
| concreteType | STRING | |
| entityId | STRING | |
| pfbEntityName | STRING | Required. Used for the PFB entity.name field of each row added to the resulting avro file. |
| fileName | STRING | Set the name of the resulting PFB file. An auto-generated name will be used if omitted. |
| sql | STRING | The SQL query string. |
| additionalFilters | ARRAY<QueryFilter> | Appends additional filters to the SQL query. These are applied before facets. Filters within the list have an AND relationship. If a WHERE clause already exists on the SQL query or facets are selected, it will also be ANDed with the query generated by these additional filters. |
| 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. |
| selectFileColumn | INTEGER | The id of the column used to select file entities (e.g. to fetch the action required for download). The column needs to be an ENTITYID type column and be part of the schema of the underlying table/view. |
| selectFileVersionColumn | INTEGER | The id of the column used as the version for selecting file entities when required (e.g. to add a materialized view query to the download cart with version enabled). The column needs to be an INTEGER type column and be part of the schema of the underlying table/view. |
| offset | INTEGER | The optional offset into the results |
| limit | INTEGER | The optional limit to the results |
| sort | ARRAY<SortItem> |