Get file details

/files/{file_id}

This call returns details about a specified file. The call returns the file's name, its tags, and all of its metadata.

Files are specified by their IDs, which you can obtain by making the API call to list files in a project.

To learn more about metadata fields and their values on the CGC, see the documentation on TCGA metadata. You can also learn more about working with tags on the CGC.

https://cgc-api.sbgenomics.com/v2/files/{file_id}

Request

Example request

GET /v2/files/598013fb2094f3f1b3b0bce4 HTTP/1.1
Host: cgc-api.sbgenomics.com
X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74
curl  -s -H "X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74" -H "content-type: application/json" -X GET "https://cgc-api.sbgenomics.com/v2/files/598013fb2094f3f1b3b0bce4"

Header Fields

Name

Description

X-SBG-Auth-Token
required

Your CGC authentication token.

Path parameters

Name

Description

file_id

The ID of the file whose details you want to GET.

Query parameters

Name

Data type

Description

fields

string

Selector specifying a subset of fields to include in the response.

Response

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

Example response body

{
  "href": "https://api.sbgenomics.com/v2/files/598013fb2094f3f1b3b0bce4",
  "id": "598013fb2094f3f1b3b0bce4",
    "name": "112848.bam",
    "size": 63703339,
    "project": "rfranklin/my_project",
    "created_on": "2017-08-01T07:55:40Z",
    "modified_on": "2017-08-01T07:55:40Z",
    "storage": {
        "type": "VOLUME",
        "volume": "rfranklin/my_volume_s3",
        "location": "bemo/demo_omed"
  },
    "origin": {
        "dataset": "tcga_grch38"
    },
    "tags": [],
    "metadata": {
        "aliquot_id": "TCGA-AB-2942-03A-02T-0134-13",
        "case_uuid": "6d271453-affa-4a71-bde5-6bf8622d83a9",
        "disease_type": "Acute Myeloid Leukemia",
        "reference_genome": "GRCh38.d1.vd1",
        "case_id": "TCGA-AB-2942",
        "gender": "female",
        "experimental_strategy": "miRNA-Seq",
        "vital_status": "alive",
        "investigation": "Acute Myeloid Leukemia",
        "sample_type": "Primary Blood Derived Cancer - Peripheral Blood",
        "platform": "Illumina",
        "race": "white",
        "primary_site": "Bone Marrow",
        "age_at_diagnosis": 67,
        "sample_id": "TCGA-AB-2942-03A",
        "days_to_death": "",
        "aliquot_uuid": "bbe18e43-d1bb-4ef2-b101-35b67f5e5a63",
        "ethnicity": "not hispanic or latino",
        "sample_uuid": "bd53c651-834c-42a2-b333-1bb64db22bce"
    }
}

Interpreting the response body:

  • The object storage denotes the type of storage for the file which can be either PLATFORM or VOLUME depending on where the file is stored.
  • The object origin denotes the origin of the file, such as the task which produced it or the dataset to which the file belongs (tcga, tcga_grch38, ccle, cptac, or target).
  • The dictionary object metadata lists the metadata fields and values for the file.
  • The object tags lists the tags for the file. Learn more about tagging your files on the CGC.
Language