{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:firebrowse/all":{"get":{"operationId":"open_data_firebrowse_all","summary":"Retrieve all data by genes Gistic2 results.","description":"GET /Analyses/CopyNumber/Genes/All","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"Format of result.","schema":{"type":"string","enum":["json","tsv","csv"],"default":"json","description":"Format of result."}},{"name":"cohort","in":"query","required":false,"description":"Narrow search to one or more TCGA disease cohorts from the scrollable list.","schema":{"type":"array","description":"Narrow search to one or more TCGA disease cohorts from the scrollable list."}},{"name":"gene","in":"query","required":false,"description":"Comma separated list of gene name(s).","schema":{"type":"array","description":"Comma separated list of gene name(s)."}},{"name":"tcga_participant_barcode","in":"query","required":false,"description":"Comma separated list of TCGA participant barcodes (e.g. TCGA-GF-A4EO).","schema":{"type":"array","description":"Comma separated list of TCGA participant barcodes (e.g. TCGA-GF-A4EO)."}},{"name":"page","in":"query","required":false,"description":"Which page (slice) of entire results set should be returned.","schema":{"type":"array","description":"Which page (slice) of entire results set should be returned."}},{"name":"page_size","in":"query","required":false,"description":"Number of records per page of results. Max is 2000.","schema":{"type":"array","description":"Number of records per page of results. Max is 2000."}},{"name":"sort_by","in":"query","required":false,"description":"Which column in the results should be used for sorting paginated results?","schema":{"type":"string","enum":["tcga_participant_barcode","cohort","gene"],"default":"cohort","description":"Which column in the results should be used for sorting paginated results?"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:firebrowse/amplified":{"get":{"operationId":"open_data_firebrowse_amplified","summary":"Retrieve Gistic2 significantly amplified genes results.","description":"GET /Analyses/CopyNumber/Genes/Amplified","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"Format of result.","schema":{"type":"string","enum":["json","tsv","csv"],"default":"json","description":"Format of result."}},{"name":"cohort","in":"query","required":false,"description":"Narrow search to one or more TCGA disease cohorts from the scrollable list.","schema":{"type":"array","description":"Narrow search to one or more TCGA disease cohorts from the scrollable list."}},{"name":"gene","in":"query","required":false,"description":"Comma separated list of gene name(s).","schema":{"type":"array","description":"Comma separated list of gene name(s)."}},{"name":"q","in":"query","required":false,"description":"Only return results with Q-value <= given threshold.","schema":{"type":"number","description":"Only return results with Q-value <= given threshold."}},{"name":"page","in":"query","required":false,"description":"Which page (slice) of entire results set should be returned.","schema":{"type":"array","description":"Which page (slice) of entire results set should be returned."}},{"name":"page_size","in":"query","required":false,"description":"Number of records per page of results. Max is 2000.","schema":{"type":"array","description":"Number of records per page of results. Max is 2000."}},{"name":"sort_by","in":"query","required":false,"description":"Which column in the results should be used for sorting paginated results?","schema":{"type":"string","enum":["q","cohort","gene"],"default":"cohort","description":"Which column in the results should be used for sorting paginated results?"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:firebrowse/deleted":{"get":{"operationId":"open_data_firebrowse_deleted","summary":"Retrieve Gistic2 significantly deleted genes results.","description":"GET /Analyses/CopyNumber/Genes/Deleted","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"Format of result.","schema":{"type":"string","enum":["json","tsv","csv"],"default":"json","description":"Format of result."}},{"name":"cohort","in":"query","required":false,"description":"Narrow search to one or more TCGA disease cohorts from the scrollable list.","schema":{"type":"array","description":"Narrow search to one or more TCGA disease cohorts from the scrollable list."}},{"name":"gene","in":"query","required":false,"description":"Comma separated list of gene name(s).","schema":{"type":"array","description":"Comma separated list of gene name(s)."}},{"name":"q","in":"query","required":false,"description":"Only return results with Q-value <= given threshold.","schema":{"type":"number","description":"Only return results with Q-value <= given threshold."}},{"name":"page","in":"query","required":false,"description":"Which page (slice) of entire results set should be returned.","schema":{"type":"array","description":"Which page (slice) of entire results set should be returned."}},{"name":"page_size","in":"query","required":false,"description":"Number of records per page of results. Max is 2000.","schema":{"type":"array","description":"Number of records per page of results. Max is 2000."}},{"name":"sort_by","in":"query","required":false,"description":"Which column in the results should be used for sorting paginated results?","schema":{"type":"string","enum":["q","cohort","gene"],"default":"cohort","description":"Which column in the results should be used for sorting paginated results?"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:firebrowse/focal":{"get":{"operationId":"open_data_firebrowse_focal","summary":"Retrieve focal data by genes Gistic2 results.","description":"GET /Analyses/CopyNumber/Genes/Focal","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"Format of result.","schema":{"type":"string","enum":["json","tsv","csv"],"default":"json","description":"Format of result."}},{"name":"cohort","in":"query","required":false,"description":"Narrow search to one or more TCGA disease cohorts from the scrollable list.","schema":{"type":"array","description":"Narrow search to one or more TCGA disease cohorts from the scrollable list."}},{"name":"gene","in":"query","required":false,"description":"Comma separated list of gene name(s).","schema":{"type":"array","description":"Comma separated list of gene name(s)."}},{"name":"tcga_participant_barcode","in":"query","required":false,"description":"Comma separated list of TCGA participant barcodes (e.g. TCGA-GF-A4EO).","schema":{"type":"array","description":"Comma separated list of TCGA participant barcodes (e.g. TCGA-GF-A4EO)."}},{"name":"page","in":"query","required":false,"description":"Which page (slice) of entire results set should be returned.","schema":{"type":"array","description":"Which page (slice) of entire results set should be returned."}},{"name":"page_size","in":"query","required":false,"description":"Number of records per page of results. Max is 2000.","schema":{"type":"array","description":"Number of records per page of results. Max is 2000."}},{"name":"sort_by","in":"query","required":false,"description":"Which column in the results should be used for sorting paginated results?","schema":{"type":"string","enum":["tcga_participant_barcode","cohort","gene"],"default":"cohort","description":"Which column in the results should be used for sorting paginated results?"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:firebrowse/thresholded":{"get":{"operationId":"open_data_firebrowse_thresholded","summary":"Retrieve all thresholded by genes Gistic2 results.","description":"GET /Analyses/CopyNumber/Genes/Thresholded","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"Format of result.","schema":{"type":"string","enum":["json","tsv","csv"],"default":"json","description":"Format of result."}},{"name":"cohort","in":"query","required":false,"description":"Narrow search to one or more TCGA disease cohorts from the scrollable list.","schema":{"type":"array","description":"Narrow search to one or more TCGA disease cohorts from the scrollable list."}},{"name":"gene","in":"query","required":false,"description":"Comma separated list of gene name(s).","schema":{"type":"array","description":"Comma separated list of gene name(s)."}},{"name":"tcga_participant_barcode","in":"query","required":false,"description":"Comma separated list of TCGA participant barcodes (e.g. TCGA-GF-A4EO).","schema":{"type":"array","description":"Comma separated list of TCGA participant barcodes (e.g. TCGA-GF-A4EO)."}},{"name":"page","in":"query","required":false,"description":"Which page (slice) of entire results set should be returned.","schema":{"type":"array","description":"Which page (slice) of entire results set should be returned."}},{"name":"page_size","in":"query","required":false,"description":"Number of records per page of results. Max is 2000.","schema":{"type":"array","description":"Number of records per page of results. Max is 2000."}},{"name":"sort_by","in":"query","required":false,"description":"Which column in the results should be used for sorting paginated results?","schema":{"type":"string","enum":["tcga_participant_barcode","cohort","gene"],"default":"cohort","description":"Which column in the results should be used for sorting paginated results?"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:firebrowse/feature-table":{"get":{"operationId":"open_data_firebrowse_feature_table","summary":"Retrieve aggregated analysis features table.","description":"GET /Analyses/FeatureTable","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"Format of result.","schema":{"type":"string","enum":["tsv","csv"],"default":"tsv","description":"Format of result."}},{"name":"cohort","in":"query","required":false,"description":"Narrow search to one or more TCGA disease cohorts from the scrollable list.","schema":{"type":"array","description":"Narrow search to one or more TCGA disease cohorts from the scrollable list."}},{"name":"date","in":"query","required":false,"description":"Select one or more date stamps.","schema":{"type":"array","description":"Select one or more date stamps."}},{"name":"column","in":"query","required":false,"description":"Comma separated list of which data columns/fields to return.","schema":{"type":"array","description":"Comma separated list of which data columns/fields to return."}},{"name":"page","in":"query","required":false,"description":"Which page (slice) of entire results set should be returned.","schema":{"type":"array","description":"Which page (slice) of entire results set should be returned."}},{"name":"page_size","in":"query","required":false,"description":"Number of records per page of results. Max is 2000.","schema":{"type":"array","description":"Number of records per page of results. Max is 2000."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:firebrowse/maf":{"get":{"operationId":"open_data_firebrowse_maf","summary":"Retrieve MutSig final analysis MAF.","description":"GET /Analyses/Mutation/MAF","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"Format of result.","schema":{"type":"string","enum":["json","tsv","csv"],"default":"json","description":"Format of result."}},{"name":"cohort","in":"query","required":false,"description":"Narrow search to one or more TCGA disease cohorts from the scrollable list.","schema":{"type":"array","description":"Narrow search to one or more TCGA disease cohorts from the scrollable list."}},{"name":"tool","in":"query","required":false,"description":"Narrow search to include only data/results produced by the selected Firehose tool.","schema":{"type":"array","description":"Narrow search to include only data/results produced by the selected Firehose tool."}},{"name":"gene","in":"query","required":false,"description":"Comma separated list of gene name(s).","schema":{"type":"array","description":"Comma separated list of gene name(s)."}},{"name":"tcga_participant_barcode","in":"query","required":false,"description":"Comma separated list of TCGA participant barcodes (e.g. TCGA-GF-A4EO).","schema":{"type":"array","description":"Comma separated list of TCGA participant barcodes (e.g. TCGA-GF-A4EO)."}},{"name":"column","in":"query","required":false,"description":"Comma separated list of which data columns/fields to return.","schema":{"type":"array","description":"Comma separated list of which data columns/fields to return."}},{"name":"page","in":"query","required":false,"description":"Which page (slice) of entire results set should be returned.","schema":{"type":"array","description":"Which page (slice) of entire results set should be returned."}},{"name":"page_size","in":"query","required":false,"description":"Number of records per page of results. Max is 2000.","schema":{"type":"array","description":"Number of records per page of results. Max is 2000."}},{"name":"sort_by","in":"query","required":false,"description":"Which column in the results should be used for sorting paginated results?","schema":{"type":"string","enum":["tcga_participant_barcode","cohort","tool","gene"],"default":"cohort","description":"Which column in the results should be used for sorting paginated results?"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:firebrowse/smg":{"get":{"operationId":"open_data_firebrowse_smg","summary":"Retrieve Significantly Mutated Genes (SMG).","description":"GET /Analyses/Mutation/SMG","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"Format of result.","schema":{"type":"string","enum":["json","tsv","csv"],"default":"json","description":"Format of result."}},{"name":"cohort","in":"query","required":false,"description":"Narrow search to one or more TCGA disease cohorts from the scrollable list.","schema":{"type":"array","description":"Narrow search to one or more TCGA disease cohorts from the scrollable list."}},{"name":"tool","in":"query","required":false,"description":"Narrow search to include only data/results produced by the selected Firehose tool.","schema":{"type":"array","description":"Narrow search to include only data/results produced by the selected Firehose tool."}},{"name":"rank","in":"query","required":false,"description":"Number of significant genes to return.","schema":{"type":"integer","description":"Number of significant genes to return."}},{"name":"gene","in":"query","required":false,"description":"Comma separated list of gene name(s).","schema":{"type":"array","description":"Comma separated list of gene name(s)."}},{"name":"q","in":"query","required":false,"description":"Only return results with Q-value <= given threshold.","schema":{"type":"number","description":"Only return results with Q-value <= given threshold."}},{"name":"page","in":"query","required":false,"description":"Which page (slice) of entire results set should be returned.","schema":{"type":"array","description":"Which page (slice) of entire results set should be returned."}},{"name":"page_size","in":"query","required":false,"description":"Number of records per page of results. Max is 2000.","schema":{"type":"array","description":"Number of records per page of results. Max is 2000."}},{"name":"sort_by","in":"query","required":false,"description":"Which column in the results should be used for sorting paginated results?","schema":{"type":"string","enum":["q","cohort","tool","gene","rank"],"default":"rank","description":"Which column in the results should be used for sorting paginated results?"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:firebrowse/reports":{"get":{"operationId":"open_data_firebrowse_reports","summary":"Retrieve links to summary reports from Firehose analysis runs.","description":"GET /Analyses/Reports","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"Format of result.","schema":{"type":"string","enum":["json","tsv","csv"],"default":"json","description":"Format of result."}},{"name":"date","in":"query","required":false,"description":"Select one or more date stamps.","schema":{"type":"array","description":"Select one or more date stamps."}},{"name":"cohort","in":"query","required":false,"description":"Narrow search to one or more TCGA disease cohorts from the scrollable list.","schema":{"type":"array","description":"Narrow search to one or more TCGA disease cohorts from the scrollable list."}},{"name":"name","in":"query","required":false,"description":"Narrow search to one or more report names.","schema":{"type":"array","description":"Narrow search to one or more report names."}},{"name":"type","in":"query","required":false,"description":"Narrow search to one or more report types.","schema":{"type":"array","description":"Narrow search to one or more report types."}},{"name":"page","in":"query","required":false,"description":"Which page (slice) of entire results set should be returned.","schema":{"type":"array","description":"Which page (slice) of entire results set should be returned."}},{"name":"page_size","in":"query","required":false,"description":"Number of records per page of results. Max is 2000.","schema":{"type":"array","description":"Number of records per page of results. Max is 2000."}},{"name":"sort_by","in":"query","required":false,"description":"Which column in the results should be used for sorting paginated results?","schema":{"type":"string","enum":["date","cohort","type","name"],"default":"date","description":"Which column in the results should be used for sorting paginated results?"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:firebrowse/m-rnaseq-quartiles":{"get":{"operationId":"open_data_firebrowse_m_rnaseq_quartiles","summary":"Returns RNASeq expression quartiles, e.g. suitable for drawing a boxplot.","description":"GET /Analyses/mRNASeq/Quartiles","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"Format of result.","schema":{"type":"string","enum":["json","tsv","csv"],"default":"json","description":"Format of result."}},{"name":"gene","in":"query","required":true,"description":"Enter a single gene name.","schema":{"type":"string","description":"Enter a single gene name."}},{"name":"cohort","in":"query","required":false,"description":"Narrow search to one or more TCGA disease cohorts from the scrollable list.","schema":{"type":"array","description":"Narrow search to one or more TCGA disease cohorts from the scrollable list."}},{"name":"protocol","in":"query","required":false,"description":"Narrow search to one or more sample characterization protocols from the scrollable list.","schema":{"type":"array","description":"Narrow search to one or more sample characterization protocols from the scrollable list."}},{"name":"sample_type","in":"query","required":false,"description":"For which type of sample(s) should quartiles be computed?","schema":{"type":"array","description":"For which type of sample(s) should quartiles be computed?"}},{"name":"Exclude","in":"query","required":false,"description":"Comma separated list of TCGA participants, identified by barcodes such as TCGA-GF-A4EO, denoting samples to exclude from computation.","schema":{"type":"array","description":"Comma separated list of TCGA participants, identified by barcodes such as TCGA-GF-A4EO, denoting samples to exclude from computation."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:firebrowse/standard-data":{"get":{"operationId":"open_data_firebrowse_standard_data","summary":"Retrieve standard data archives.","description":"GET /Archives/StandardData","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"Format of result.","schema":{"type":"string","enum":["json","tsv","csv"],"default":"json","description":"Format of result."}},{"name":"date","in":"query","required":false,"description":"Select one or more date stamps.","schema":{"type":"array","description":"Select one or more date stamps."}},{"name":"cohort","in":"query","required":false,"description":"Narrow search to one or more TCGA disease cohorts from the scrollable list.","schema":{"type":"array","description":"Narrow search to one or more TCGA disease cohorts from the scrollable list."}},{"name":"data_type","in":"query","required":false,"description":"Narrow search to one or more TCGA data types from the scrollable list.","schema":{"type":"array","description":"Narrow search to one or more TCGA data types from the scrollable list."}},{"name":"tool","in":"query","required":false,"description":"Narrow search to include only data/results produced by the selected Firehose tool.","schema":{"type":"array","description":"Narrow search to include only data/results produced by the selected Firehose tool."}},{"name":"platform","in":"query","required":false,"description":"Narrow search to one or more TCGA data generation platforms from the scrollable list.","schema":{"type":"array","description":"Narrow search to one or more TCGA data generation platforms from the scrollable list."}},{"name":"center","in":"query","required":false,"description":"Narrow search to one or more TCGA centers from the scrollable list.","schema":{"type":"array","description":"Narrow search to one or more TCGA centers from the scrollable list."}},{"name":"level","in":"query","required":false,"description":"Narrow search to one or more TCGA data levels.","schema":{"type":"array","description":"Narrow search to one or more TCGA data levels."}},{"name":"protocol","in":"query","required":false,"description":"Narrow search to one or more sample characterization protocols from the scrollable list.","schema":{"type":"array","description":"Narrow search to one or more sample characterization protocols from the scrollable list."}},{"name":"page","in":"query","required":false,"description":"Which page (slice) of entire results set should be returned.","schema":{"type":"array","description":"Which page (slice) of entire results set should be returned."}},{"name":"page_size","in":"query","required":false,"description":"Number of records per page of results. Max is 2000.","schema":{"type":"array","description":"Number of records per page of results. Max is 2000."}},{"name":"sort_by","in":"query","required":false,"description":"Which column in the results should be used for sorting paginated results?","schema":{"type":"string","enum":["cohort","protocol","center","data_type","level","tool","platform","date"],"default":"cohort","description":"Which column in the results should be used for sorting paginated results?"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:firebrowse/centers":{"get":{"operationId":"open_data_firebrowse_centers","summary":"Obtain identities of TCGA consortium member centers.","description":"GET /Metadata/Centers","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"Format of result.","schema":{"type":"string","enum":["json","tsv","csv"],"default":"json","description":"Format of result."}},{"name":"center","in":"query","required":false,"description":"Narrow search to one or more TCGA centers from the scrollable list.","schema":{"type":"array","description":"Narrow search to one or more TCGA centers from the scrollable list."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:firebrowse/clinical-names":{"get":{"operationId":"open_data_firebrowse_clinical_names","summary":"Retrieve names of all TCGA clinical data elements (CDEs).","description":"GET /Metadata/ClinicalNames","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"Format of result.","schema":{"type":"string","enum":["json","tsv","csv"],"default":"json","description":"Format of result."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:firebrowse/clinical-names-fh":{"get":{"operationId":"open_data_firebrowse_clinical_names_fh","summary":"Retrieve names of CDEs normalized by Firehose and selected for analyses.","description":"GET /Metadata/ClinicalNames_FH","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"Format of result.","schema":{"type":"string","enum":["json","tsv","csv"],"default":"json","description":"Format of result."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:firebrowse/cohorts":{"get":{"operationId":"open_data_firebrowse_cohorts","summary":"Translate TCGA cohort abbreviations to full disease names.","description":"GET /Metadata/Cohorts","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"Format of result.","schema":{"type":"string","enum":["json","tsv","csv"],"default":"json","description":"Format of result."}},{"name":"cohort","in":"query","required":false,"description":"Narrow search to one or more TCGA disease cohorts from the scrollable list.","schema":{"type":"array","description":"Narrow search to one or more TCGA disease cohorts from the scrollable list."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:firebrowse/counts":{"get":{"operationId":"open_data_firebrowse_counts","summary":"Retrieve sample counts.","description":"GET /Metadata/Counts","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"Format of result.","schema":{"type":"string","enum":["json","tsv","csv"],"default":"json","description":"Format of result."}},{"name":"date","in":"query","required":false,"description":"Select one or more date stamps.","schema":{"type":"array","description":"Select one or more date stamps."}},{"name":"cohort","in":"query","required":false,"description":"Narrow search to one or more TCGA disease cohorts from the scrollable list.","schema":{"type":"array","description":"Narrow search to one or more TCGA disease cohorts from the scrollable list."}},{"name":"sample_type","in":"query","required":false,"description":"Narrow search to one or more TCGA sample types from the scrollable list.","schema":{"type":"array","description":"Narrow search to one or more TCGA sample types from the scrollable list."}},{"name":"data_type","in":"query","required":false,"description":"Narrow search to one or more TCGA data types from the scrollable list.","schema":{"type":"array","description":"Narrow search to one or more TCGA data types from the scrollable list."}},{"name":"totals","in":"query","required":false,"description":"Output an entry providing the totals for each data type.","schema":{"type":"boolean","default":true,"description":"Output an entry providing the totals for each data type."}},{"name":"sort_by","in":"query","required":false,"description":"Which column in the results should be used for sorting paginated results?","schema":{"type":"string","enum":["cohort"],"default":"cohort","description":"Which column in the results should be used for sorting paginated results?"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:firebrowse/dates":{"get":{"operationId":"open_data_firebrowse_dates","summary":"Retrieve dates of all GDAC Firehose stddata & analyses runs that have been ingested into FireBrowse.","description":"GET /Metadata/Dates","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"Format of result.","schema":{"type":"string","enum":["json","tsv","csv"],"default":"json","description":"Format of result."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:firebrowse/heart-beat":{"get":{"operationId":"open_data_firebrowse_heart_beat","summary":"Simple way to discern whether API server is up and running","description":"GET /Metadata/HeartBeat","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"Format of result.","schema":{"type":"string","enum":["json","tsv","csv"],"default":"json","description":"Format of result."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:firebrowse/mafcol-names":{"get":{"operationId":"open_data_firebrowse_mafcol_names","summary":"Retrieve names of all columns in the mutation annotation files (MAFs) served by FireBrowse.","description":"GET /Metadata/MAFColNames","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"Format of result.","schema":{"type":"string","enum":["json","tsv","csv"],"default":"json","description":"Format of result."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:firebrowse/patients":{"get":{"operationId":"open_data_firebrowse_patients","summary":"Retrieve list of all TCGA patients.","description":"GET /Metadata/Patients","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"Format of result.","schema":{"type":"string","enum":["json","tsv","csv"],"default":"json","description":"Format of result."}},{"name":"cohort","in":"query","required":false,"description":"Narrow search to one or more TCGA disease cohorts from the scrollable list.","schema":{"type":"array","description":"Narrow search to one or more TCGA disease cohorts from the scrollable list."}},{"name":"page","in":"query","required":false,"description":"Which page (slice) of entire results set should be returned.","schema":{"type":"array","description":"Which page (slice) of entire results set should be returned."}},{"name":"page_size","in":"query","required":false,"description":"Number of records per page of results. Max is 2000.","schema":{"type":"array","description":"Number of records per page of results. Max is 2000."}},{"name":"sort_by","in":"query","required":false,"description":"Which column in the results should be used for sorting paginated results?","schema":{"type":"string","enum":["cohort"],"default":"cohort","description":"Which column in the results should be used for sorting paginated results?"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:firebrowse/platforms":{"get":{"operationId":"open_data_firebrowse_platforms","summary":"Translate TCGA platform codes to full platform names.","description":"GET /Metadata/Platforms","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"Format of result.","schema":{"type":"string","enum":["json","tsv","csv"],"default":"json","description":"Format of result."}},{"name":"platform","in":"query","required":false,"description":"Narrow search to one or more TCGA data generation platforms from the scrollable list.","schema":{"type":"array","description":"Narrow search to one or more TCGA data generation platforms from the scrollable list."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:firebrowse/barcode":{"get":{"operationId":"open_data_firebrowse_barcode","summary":"Given a TCGA barcode, return its short letter sample type code.","description":"GET /Metadata/SampleType/Barcode/{TCGA_Barcode}","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"Format of result.","schema":{"type":"string","enum":["json","tsv","csv"],"default":"json","description":"Format of result."}},{"name":"TCGA_Barcode","in":"query","required":true,"description":"Enter a single TCGA barcode, of any form: e.g. TCGA-GF-A4EO-06 or TCGA-EL-A3D5-01A-22D-A202-08","schema":{"type":"string","description":"Enter a single TCGA barcode, of any form: e.g. TCGA-GF-A4EO-06 or TCGA-EL-A3D5-01A-22D-A202-08"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:firebrowse/code":{"get":{"operationId":"open_data_firebrowse_code","summary":"Translate from numeric to symbolic TCGA sample codes.","description":"GET /Metadata/SampleType/Code/{code}","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"Format of result.","schema":{"type":"string","enum":["json","tsv","csv"],"default":"json","description":"Format of result."}},{"name":"code","in":"query","required":true,"description":"Narrow search to one or more TCGA sample type codes.","schema":{"type":"array","description":"Narrow search to one or more TCGA sample type codes."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:firebrowse/short-letter-code":{"get":{"operationId":"open_data_firebrowse_short_letter_code","summary":"Translate from symbolic to numeric TCGA sample codes.","description":"GET /Metadata/SampleType/ShortLetterCode/{short_letter_code}","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"Format of result.","schema":{"type":"string","enum":["json","tsv","csv"],"default":"json","description":"Format of result."}},{"name":"short_letter_code","in":"query","required":true,"description":"TCGA sample type short letter code(s) (e.g. TP, NB, etc.).","schema":{"type":"array","description":"TCGA sample type short letter code(s) (e.g. TP, NB, etc.)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:firebrowse/sample-types":{"get":{"operationId":"open_data_firebrowse_sample_types","summary":"Return all TCGA sample type codes, both numeric and symbolic.","description":"GET /Metadata/SampleTypes","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"Format of result.","schema":{"type":"string","enum":["json","tsv","csv"],"default":"json","description":"Format of result."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:firebrowse/tssites":{"get":{"operationId":"open_data_firebrowse_tssites","summary":"Obtain identities of tissue source sites in TCGA.","description":"GET /Metadata/TSSites","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"Format of result.","schema":{"type":"string","enum":["json","tsv","csv"],"default":"json","description":"Format of result."}},{"name":"tss_code","in":"query","required":false,"description":"Narrow search to one or more TSS codes","schema":{"type":"array","description":"Narrow search to one or more TSS codes"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:firebrowse/clinical":{"get":{"operationId":"open_data_firebrowse_clinical","summary":"Retrieve TCGA CDEs verbatim, i.e. not normalized by Firehose.","description":"GET /Samples/Clinical","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"Format of result.","schema":{"type":"string","enum":["json","tsv","csv"],"default":"json","description":"Format of result."}},{"name":"cohort","in":"query","required":false,"description":"Narrow search to one or more TCGA disease cohorts from the scrollable list.","schema":{"type":"array","description":"Narrow search to one or more TCGA disease cohorts from the scrollable list."}},{"name":"tcga_participant_barcode","in":"query","required":false,"description":"Comma separated list of TCGA participant barcodes (e.g. TCGA-GF-A4EO).","schema":{"type":"array","description":"Comma separated list of TCGA participant barcodes (e.g. TCGA-GF-A4EO)."}},{"name":"cde_name","in":"query","required":false,"description":"Retrieve results only for specified CDEs, per the Metadata/ClinicalNames function","schema":{"type":"array","description":"Retrieve results only for specified CDEs, per the Metadata/ClinicalNames function"}},{"name":"page","in":"query","required":false,"description":"Which page (slice) of entire results set should be returned.","schema":{"type":"array","description":"Which page (slice) of entire results set should be returned."}},{"name":"page_size","in":"query","required":false,"description":"Number of records per page of results. Max is 2000.","schema":{"type":"array","description":"Number of records per page of results. Max is 2000."}},{"name":"sort_by","in":"query","required":false,"description":"Which column in the results should be used for sorting paginated results?","schema":{"type":"string","enum":["tcga_participant_barcode","cohort","cde_name"],"default":"cohort","description":"Which column in the results should be used for sorting paginated results?"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:firebrowse/clinical-fh":{"get":{"operationId":"open_data_firebrowse_clinical_fh","summary":"Retrieve CDEs normalized by Firehose and selected for analyses.","description":"GET /Samples/Clinical_FH","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"Format of result.","schema":{"type":"string","enum":["json","tsv","csv"],"default":"json","description":"Format of result."}},{"name":"cohort","in":"query","required":false,"description":"Narrow search to one or more TCGA disease cohorts from the scrollable list.","schema":{"type":"array","description":"Narrow search to one or more TCGA disease cohorts from the scrollable list."}},{"name":"tcga_participant_barcode","in":"query","required":false,"description":"Comma separated list of TCGA participant barcodes (e.g. TCGA-GF-A4EO).","schema":{"type":"array","description":"Comma separated list of TCGA participant barcodes (e.g. TCGA-GF-A4EO)."}},{"name":"fh_cde_name","in":"query","required":false,"description":"Retrieve results only for the CDEs specified from the scrollable list.","schema":{"type":"array","description":"Retrieve results only for the CDEs specified from the scrollable list."}},{"name":"page","in":"query","required":false,"description":"Which page (slice) of entire results set should be returned.","schema":{"type":"array","description":"Which page (slice) of entire results set should be returned."}},{"name":"page_size","in":"query","required":false,"description":"Number of records per page of results. Max is 2000.","schema":{"type":"array","description":"Number of records per page of results. Max is 2000."}},{"name":"sort_by","in":"query","required":false,"description":"Which column in the results should be used for sorting paginated results?","schema":{"type":"string","enum":["tcga_participant_barcode","cohort","fh_cde_name"],"default":"cohort","description":"Which column in the results should be used for sorting paginated results?"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:firebrowse/m-rnaseq":{"get":{"operationId":"open_data_firebrowse_m_rnaseq","summary":"Retrieve mRNASeq data.","description":"GET /Samples/mRNASeq","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"Format of result.","schema":{"type":"string","enum":["json","tsv","csv"],"default":"json","description":"Format of result."}},{"name":"gene","in":"query","required":false,"description":"Comma separated list of gene name(s).","schema":{"type":"array","description":"Comma separated list of gene name(s)."}},{"name":"cohort","in":"query","required":false,"description":"Narrow search to one or more TCGA disease cohorts from the scrollable list.","schema":{"type":"array","description":"Narrow search to one or more TCGA disease cohorts from the scrollable list."}},{"name":"tcga_participant_barcode","in":"query","required":false,"description":"Comma separated list of TCGA participant barcodes (e.g. TCGA-GF-A4EO).","schema":{"type":"array","description":"Comma separated list of TCGA participant barcodes (e.g. TCGA-GF-A4EO)."}},{"name":"sample_type","in":"query","required":false,"description":"Narrow search to one or more TCGA sample types from the scrollable list.","schema":{"type":"array","description":"Narrow search to one or more TCGA sample types from the scrollable list."}},{"name":"protocol","in":"query","required":false,"description":"Narrow search to one or more sample characterization protocols from the scrollable list.","schema":{"type":"array","description":"Narrow search to one or more sample characterization protocols from the scrollable list."}},{"name":"page","in":"query","required":false,"description":"Which page (slice) of entire results set should be returned.","schema":{"type":"array","description":"Which page (slice) of entire results set should be returned."}},{"name":"page_size","in":"query","required":false,"description":"Number of records per page of results. Max is 2000.","schema":{"type":"array","description":"Number of records per page of results. Max is 2000."}},{"name":"sort_by","in":"query","required":false,"description":"Which column in the results should be used for sorting paginated results?","schema":{"type":"string","enum":["tcga_participant_barcode","cohort","gene","protocol","sample_type"],"default":"cohort","description":"Which column in the results should be used for sorting paginated results?"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:firebrowse/mi-rseq":{"get":{"operationId":"open_data_firebrowse_mi_rseq","summary":"Retrieve miRSeq data.","description":"GET /Samples/miRSeq","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"Format of result.","schema":{"type":"string","enum":["json","tsv","csv"],"default":"json","description":"Format of result."}},{"name":"mir","in":"query","required":false,"description":"Comma separated list of miR names (e.g. hsa-let-7b-5p,hsa-let-7a-1).","schema":{"type":"array","description":"Comma separated list of miR names (e.g. hsa-let-7b-5p,hsa-let-7a-1)."}},{"name":"cohort","in":"query","required":false,"description":"Narrow search to one or more TCGA disease cohorts from the scrollable list.","schema":{"type":"array","description":"Narrow search to one or more TCGA disease cohorts from the scrollable list."}},{"name":"tcga_participant_barcode","in":"query","required":false,"description":"Comma separated list of TCGA participant barcodes (e.g. TCGA-GF-A4EO).","schema":{"type":"array","description":"Comma separated list of TCGA participant barcodes (e.g. TCGA-GF-A4EO)."}},{"name":"tool","in":"query","required":false,"description":"Narrow search to include only data/results produced by the selected Firehose tool.","schema":{"type":"array","description":"Narrow search to include only data/results produced by the selected Firehose tool."}},{"name":"sample_type","in":"query","required":false,"description":"Narrow search to one or more TCGA sample types from the scrollable list.","schema":{"type":"array","description":"Narrow search to one or more TCGA sample types from the scrollable list."}},{"name":"page","in":"query","required":false,"description":"Which page (slice) of entire results set should be returned.","schema":{"type":"array","description":"Which page (slice) of entire results set should be returned."}},{"name":"page_size","in":"query","required":false,"description":"Number of records per page of results. Max is 2000.","schema":{"type":"array","description":"Number of records per page of results. Max is 2000."}},{"name":"sort_by","in":"query","required":false,"description":"Which column in the results should be used for sorting paginated results?","schema":{"type":"string","enum":["tcga_participant_barcode","cohort","tool","mir","sample_type"],"default":"cohort","description":"Which column in the results should be used for sorting paginated results?"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}