Get a file's metadata

files/{file_id}/metadata

This call returns the metadata values for the specified file.

🚧

Metadata

Learn more about metadata fields and their values for your uploaded, private files on the CGC.

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

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

Request

Example request

GET /v2/files/568e69abe9b0307bc0414164/metadata 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/568e69abe9b0307bc0414164/metadata"

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

{
  "investigation": "TCGA-ACC",
  "days_to_death": 994,
  "vital_status": "Dead",
  "gender": "FEMALE",
  "case_id": "TCGA-OR-A5K2",
  "primary_site": "Adrenal Gland",
  "ethnicity": "Not available",
  "disease_type": "Adrenocortical Carcinoma",
  "race": "WHITE",
  "case_uuid": "6D980831-219E-40A0-9B41-E64C3FB0BD1A",
  "experimental_strategy": "Not available",
  "platform": "Hospital Record",
}
Language