datafilenamekey_list_from_sample¶
Takes a sample barcode as a required parameter and returns cloud storage paths to files associated with that sample. The user does not need to be authenticated to retrieve a list of open-access file paths only. User must be authenticated and have dbGaP authorization in order to see paths to controlled-access files. If the user is not dbGaP authorized, controlled-access files will not appear.
Access control: To call this method, you must have the following roles:
- None
Request
HTTP request
GET https://api-dot-isb-cgc.appspot.com/_ah/api/cohort_api/v1/datafilenamekey_list_from_sample
Parameters
| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
| sample_barcode | string | Required. Barcode of the sample to get file paths for. |
| platform | string | Optional. Filter file results by platform. |
| pipeline | string | Optional. Filter file results by pipeline. |
| token | string | Optional. Access token to authenticate user. |
Response
If successful, this method returns a response body with the following structure:
{
"kind": "cohort_api#cohortsItem",
"count": string,
"datafilenamekeys": [string]
}
| Property name | Value | Description |
|---|---|---|
| kind | cohort_api#cohortsItem | The resource type. |
| count | string | Integer representing the length of the datafilenamekeys list. |
| datafilenamekeys[] | list | List of cloud storage file paths associated with each sample within the cohort. If a file path is not yet available in the metadata_data table, the cloud storage bucket name is listed with “/file-path-not-yet-available”. If no file paths are listed (for example, if only controlled-access files are listed for that sample barcode and the user does not have dbGaP authorization), the response will not contain this field. |