Synapse REST API

Start an asynchronous job to download a table/view query result as Portable Format for Biomedical (PFB) file.

The schema of the resulting PFB file will be an extension of the PFB Entity's schema. The query's select statement will define the schema of a new type of PFB object which will be appended to the entity.object union schema.

entity field	description
entity.id	The concatenation of the row's row_id + '_' + row_version. The entity.id will be null for cases where a row's row_id and row_version are null.
entity.name	Will always match the provided DownloadPFBRequest.pfbEntityName
entity.object	Will contain the actual data of the query result row.

The resulting PFB file will not include PFB Metadata rows.

Use the returned job id and GET /entity/{id}/table/download/pfb/async/get to get the results of the query

Resource URL

https://repo-prod.prod.sagebase.org/repo/v1/entity/{id}/table/download/pfb/async/start

Resource URL Variables

{id}	The ID of the TableEntity.