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 Platform.

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

Path

https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/files/{file_id}/metadata

Request

Example request

HTTP

GET /v2/files/567890abc9b0307bc0414164/metadata HTTP/1.1
Host: api.sb.biodatacatalyst.nhlbi.nih.gov
X-SBG-Auth-Token: 1e43fEXampLEa5523dfd14exAMPle3e5

cURL

curl  -s -H "X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7" -H "content-type: application/json" -X GET "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/files/567890abc9b0307bc0414164/metadata"

Header Fields

Name	Description
X-SBG-Auth-Token required	Your 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 response codes that may be contained in the body of the response.

Example response body

JSON

{
    "__inherit__": "input_bam",
    "reference_genome": "human_g1k_v37_decoy",
    "sample_id": "HCC1143_20M",
    "case_id": "CCLE-HCC1143",
    "investigation": "CCLE-BRCA",
    "sample_type": "Cell Line",
    "experimental_strategy": "RNA-Seq",
    "platform": "Illumina",
    "quality_scale": "sanger",
    "species": "Homo sapiens",
    "sbg_public_files_category": "test"
}