List files (primary method)

/files

This call returns a list of files and subdirectories in a specified project or directory within a project, with specified properties that you can access. The project or directory whose contents you want to list is specified as a query parameter in the call. Further properties to filter by can also be specified as query parameters.

Note that this call lists both files and subdirectories in the specified project or directory within a project, but not the contents of the subdirectories. To list the contents of a subdirectory, make a new call and specify the subdirectory ID as the parent parameter.

Don't forget that projects on the Platform are specified by their short names.

πŸ‘

File IDs

The file IDs returned by this call are useful for issuing further queries to get more information about a particular file.

https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/files

🚧

Alias call

There is a second method for listing files in a project: GET projects/{project_owner}/{project_name}/files. The call listed here is the primary and preferred method for performing this operation.

Request

Header Fields

NameDescription
X-SBG-Auth-Token
required
Your Platform authentication token.

Query Parameters

You can use query parameters, listed in the table below, to return specific results. See the tip box below for details on OR and AND operations while filtering. Below the table, you'll see examples of API requests using various parameters.

πŸ‘

Tips for filtering

When filtering on any resource, including the same field several times with different filtering criteria results in an implicit OR operation for that field and the different criteria.

When filtering by different specified fields, an implicit AND is performed between those criteria. Thus, the call in Example 3 above would return files matching the specified project AND sample ID AND library.

NameData typeDescription
project_owner
required
stringThe owner of the project you are listing files from.
project
required
The project's short name
namestringList file with this name. Note that the name must be an exact complete string for the results to match.

Multiple names can be separated by an OR operation, as shown in example 4 below. The OR operation is implied when the same parameter is queried multiple times in the same API request
metadata.{field}stringList only files with that have the specified value in metadata field.

Multiple instances of the same metadata field are implicitly separated by an OR operation. Conversely, different metadata fields are implicitly separated by an AND operation, as shown in example 3 below.
origin.taskstringList only files produced by task specified by ID in this field
origin.datasetstringList only files which are part of the dataset specified in this field. Possible values include: tcga, tcga_grch38, ccle, cptac, and target.
fieldsstringSelector specifying a subset of fields to include in the response.
tagstringList files containing this tag. Note that the tag must be an exact complete string for the results to match. Multiple tags can be separated by an OR operation, as shown in example 5 below. The OR operation is implied when the same parameter is queried multiple times in the same API request.

Keep in mind that tags are different from metadata. Learn more about tagging your files on the Platform.

πŸ‘

Limit your results

Don't forget that you can use filtering with the limit parameter to restrict the number of files returned by this call.

Example requests

Since file filtering is a powerful feature, we have included some example usages.

Example 1: List all files in the project 'my-project':

GET /v2/files?project=rfranklin/my-project HTTP/1.1
Host: api.sb.biodatacatalyst.nhlbi.nih.gov
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74
curl -s -H "X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7" -H "content-type: application/json" -X GET "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/files?project=RFranklin/my-project"

Example 2: List all files in 'my-project' with a specific sample ID

GET /v2/files?project=rfranklin/my-project&metadata.sample_id=SAMPLE1 HTTP/1.1
Host: api.sb.biodatacatalyst.nhlbi.nih.gov
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74
curl -s -H "X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7" -H "content-type: application/json" -X GET "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/files?project=RFranklin/my-project&metadata.sample_id=SAMPLE1"

Example 3: List all files in 'my-project' that were produced by a specific task with a specific library and sample ID:

GET /v2/files?project=rfranklin/my-project&metadata.sample_id=ERR315335&metadata.library_id=HiSeqX_R HTTP/1.1
Host: api.sb.biodatacatalyst.nhlbi.nih.gov
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74
curl -s -H "X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7" -H "content-type: application/json" -X GET "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/files?project=my-project&metadata.sample_id=ERR315335&origin.task=48f79ccf-12b3-45b6-789c-b1e8d88dabcd"

Example 4: List all files in 'my-project' matching the exact names included in the query parameters:

GET /v2/files?project=rfranklin/my-project&name=dbsnp_137.b37.vcf&name=1000G_phase1.indels.b37.vcf&name=Mills_and_1000G_gold_standard.indels.b37.sites.vcf HTTP/1.1
Host: api.sb.biodatacatalyst.nhlbi.nih.gov
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74
curl -s -H "X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7" -H "content-type: application/json" -X GET "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/files?project=my-project&name=dbsnp_137.b37.vcf&name=1000G_phase1.indels.b37.vcf&name=Mills_and_1000G_gold_standard.indels.b37.sites.vcf"

Example 5: List all files in 'my-project' matching the exact tags included in the parameters:

GET /v2/files?project=rfranklin/my-project&tag=test1b&tag=my_first_project&fields=_all HTTP/1.1
Host: api.sb.biodatacatalyst.nhlbi.nih.gov
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74
curl -s -H "X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7" -H "content-type: application/json" -X GET "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/files?project=franklin/my-project&tag=test1b&tag=my_first_project"

Example 6: List all files in 'my-project' from the TCGA GRCh38 dataset.

GET /v2/files?project=rfranklin/my-project&origin.dataset=tcga_grch38&fields=name,origin&limit=100
Host: api.sb.biodatacatalyst.nhlbi.nih.gov
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74

Response

See a list of response codes that may be contained in the body of the response.

Example response body

{
  "href": "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/files?offset=0&limit=25&project=RFranklin/my-project",
  "items": [
    {
      "href": "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/files/567890abc9b0307bc0414164",
      "id": "567890abc9b0307bc0414164",
      "name": "1000G_phase1.indels.b37.vc",
      "project": "RFranklin/my-project"
    },
    {
      "id": "567890abc1e5339df0414123",
      "name": "1000G_omni2.5.b37.vcf",
      "project": "RFranklin/my-project"
    },
    {
      "href": "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/files/567890abc4f3066bc3750174",
      "id": "567890abc4f3066bc3750174",
      "name": "1000G_phase1.snps.high_confidence.b37.vcf",
      "project": "RFranklin/my-project"
    }
  ],
  "links": []
}