samples().cloud_storage_file_paths()¶
Takes a sample barcode as a required parameter and returns cloud storage paths to files associated with that sample.
Example:
curl https://api-dot-isb-cgc.appspot.com/_ah/api/isb_cgc_tcga_api/v3/tcga/samples/TCGA-W5-AA2O-10A/cloud_storage_file_paths
API explorer example:
Click here to see this endpoint in Google’s API explorer.
Python API Client Example:
from googleapiclient.discovery import build
import httplib2
def get_unauthorized_service():
api = 'isb_cgc_tcga_api'
version = 'v3'
site = 'https://api-dot-isb-cgc.appspot.com'
discovery_url = '%s/_ah/api/discovery/v1/apis/%s/%s/rest' % (site, api, version)
return build(api, version, discoveryServiceUrl=discovery_url, http=httplib2.Http())
service = get_unauthorized_service()
data = service.samples().cloud_storage_file_paths(sample_barcode='TCGA-W5-AA2R-01A').execute()
Request
HTTP request:
GET https://api-dot-isb-cgc.appspot.com/_ah/api/isb_cgc_tcga_api/v3/tcga/samples/{sample_barcode}/cloud_storage_file_paths
Parameters
| Parameter name | Value | Description |
|---|---|---|
| analysis_workflow_type | string | Optional. |
| data_category | string | Optional. |
| data_format | string | Optional. |
| data_type | string | Optional. |
| experimental_strategy | string | Optional. |
| genomic_build | string | Optional. |
| platform | string | Optional. |
| sample_barcode | string | Required. |
Response
If successful, this method returns a response body with the following structure:
{
"cloud_storage_file_paths": [string],
"count": integer
}
| Parameter name | Value | Description |
|---|---|---|
| cloud_storage_file_paths[] | list | List of Google Cloud Storage paths of files associated with the cohort. |
| count | integer | Number of Google Cloud Storage paths returned for the cohort. |