{"_id":"5b0e13ffc4664e0003c75ba6","__v":0,"project":"5b0e13ffc4664e0003c75a66","user":"554340dfb7f4540d00fcef1d","version":{"_id":"5b0e13ffc4664e0003c75a67","project":"5b0e13ffc4664e0003c75a66","__v":4,"createdAt":"2015-09-17T16:58:03.490Z","releaseDate":"2015-09-17T16:58:03.490Z","categories":["5b0e13ffc4664e0003c75a68","5b0e13ffc4664e0003c75a69","5b0e13ffc4664e0003c75a6a","5b0e13ffc4664e0003c75a6b","5b0e13ffc4664e0003c75a6c","5b0e13ffc4664e0003c75a6d","5b0e13ffc4664e0003c75a6e","5b0e13ffc4664e0003c75a6f","5b0e13ffc4664e0003c75a70","5b0e13ffc4664e0003c75a71","5b0e13ffc4664e0003c75a72","5b0e13ffc4664e0003c75a73","5b0e13ffc4664e0003c75a74","5b0e13ffc4664e0003c75a75","5b0e13ffc4664e0003c75a76","5b0e13ffc4664e0003c75a77","5b0e13ffc4664e0003c75a89","5b0e13ffc4664e0003c75a8a","5b0e13ffc4664e0003c75a9d","5b0e13ffc4664e0003c75a9e","5b0e13ffc4664e0003c75a9f","5b0e13ffc4664e0003c75aa0","5b0e13ffc4664e0003c75aa1","5b0e13ffc4664e0003c75aa2","5b0e13ffc4664e0003c75aa3","5b0e13ffc4664e0003c75aa4","5b0e13ffc4664e0003c75aa5","5b0e13ffc4664e0003c75aa6","5b0e13ffc4664e0003c75aa7","5b0e13ffc4664e0003c75aa8","5b0e13ffc4664e0003c75aa9","5b0e13ffc4664e0003c75aaa","5b0e13ffc4664e0003c75aab","5b0e13ffc4664e0003c75aac","5b0e13ffc4664e0003c75aad","5b0e13ffc4664e0003c75aae","5b0e13ffc4664e0003c75aaf","5b0e13ffc4664e0003c75ab2","5bb3374f4306ad0003eb18e7","5bbf3c5373e72a000318362b","5bc065567d1cb0000384c649","5cbf19a5f9181f0033fbb968"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"5b0e13ffc4664e0003c75a75","project":"5b0e13ffc4664e0003c75a66","version":"5b0e13ffc4664e0003c75a67","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-09-17T17:34:34.937Z","from_sync":false,"order":32,"slug":"api","title":"API Reference"},"parentDoc":null,"githubsync":"","metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-07T14:39:38.626Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","examples":{"codes":[]},"method":"get","auth":"required","params":[],"url":""},"isReference":true,"order":36,"body":"This call returns the metadata values for the specified file. \n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Metadata\",\n  \"body\": \"Learn more about [metadata fields and their values](doc:metadata-for-private-data) for your uploaded, private files on the Platform.\"\n}\n[/block]\nFiles are specified by their IDs, which you can obtain by making the API call to [list files in a project ](doc:list-files-in-a-project).\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://f4c-api.sbgenomics.com/v2/files/{file_id}/metadata\",\n      \"language\": \"text\",\n      \"name\": \"Path\"\n    }\n  ]\n}\n[/block]\n##Request\n\n###Example request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /v2/files/562e449060b274321afb6091/metadata HTTP/1.1\\nHost: f4c-api.sbgenomics.com\\nX-SBG-Auth-Token: 565357a1e4b09c884b29334a\\n\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl  -s -H \\\"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\\\" -H \\\"content-type: application/json\\\" -X GET \\\"https://f4c-api.sbgenomics.com/v2/files/565357a1e4b09c884b29334a/metadata\\\"\",\n      \"language\": \"curl\",\n      \"name\": \"cURL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n###Header Fields\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`X-SBG-Auth-Token`\\n_required_\",\n    \"0-1\": \"Your [authentication token](doc:get-your-authentication-token).\",\n    \"h-2\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n###Path parameters\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`file_id`\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-1\": \"The ID of the file whose details you want to GET.\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n###Query parameters\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`fields`\",\n    \"0-1\": \"string\",\n    \"0-2\": \"Selector specifying a subset of fields to include in the response.\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n##Response\n\n[See a list of response codes that may be contained in the body of the response.](doc:api-status-codes) \n\n###Example response body\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"__inherit__\\\": \\\"input_bam\\\",\\n    \\\"reference_genome\\\": \\\"human_g1k_v37_decoy\\\",\\n    \\\"sample_id\\\": \\\"HCC1143_20M\\\",\\n    \\\"case_id\\\": \\\"CCLE-HCC1143\\\",\\n    \\\"investigation\\\": \\\"CCLE-BRCA\\\",\\n    \\\"sample_type\\\": \\\"Cell Line\\\",\\n    \\\"experimental_strategy\\\": \\\"RNA-Seq\\\",\\n    \\\"platform\\\": \\\"Illumina\\\",\\n    \\\"quality_scale\\\": \\\"sanger\\\",\\n    \\\"species\\\": \\\"Homo sapiens\\\",\\n    \\\"sbg_public_files_category\\\": \\\"test\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"files/{file_id}/metadata","slug":"get-a-files-metadata","type":"endpoint","title":"Get a file's metadata"}

getGet a file's metadata

files/{file_id}/metadata

This call returns the metadata values for the specified file. [block:callout] { "type": "warning", "title": "Metadata", "body": "Learn more about [metadata fields and their values](doc:metadata-for-private-data) for your uploaded, private files on the Platform." } [/block] Files are specified by their IDs, which you can obtain by making the API call to [list files in a project ](doc:list-files-in-a-project). [block:code] { "codes": [ { "code": "https://f4c-api.sbgenomics.com/v2/files/{file_id}/metadata", "language": "text", "name": "Path" } ] } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "GET /v2/files/562e449060b274321afb6091/metadata HTTP/1.1\nHost: f4c-api.sbgenomics.com\nX-SBG-Auth-Token: 565357a1e4b09c884b29334a\n", "language": "http", "name": null }, { "code": "curl -s -H \"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\" -H \"content-type: application/json\" -X GET \"https://f4c-api.sbgenomics.com/v2/files/565357a1e4b09c884b29334a/metadata\"", "language": "curl", "name": "cURL" } ], "sidebar": true } [/block] ###Header Fields [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": "`X-SBG-Auth-Token`\n_required_", "0-1": "Your [authentication token](doc:get-your-authentication-token).", "h-2": "" }, "cols": 2, "rows": 1 } [/block] ###Path parameters [block:parameters] { "data": { "0-0": "`file_id`", "h-0": "Name", "h-1": "Description", "0-1": "The ID of the file whose details you want to GET." }, "cols": 2, "rows": 1 } [/block] ###Query parameters [block:parameters] { "data": { "h-0": "Name", "h-1": "Data type", "h-2": "Description", "0-0": "`fields`", "0-1": "string", "0-2": "Selector specifying a subset of fields to include in the response." }, "cols": 3, "rows": 1 } [/block] ##Response [See a list of response codes that may be contained in the body of the response.](doc:api-status-codes) ###Example response body [block:code] { "codes": [ { "code": "{\n \"__inherit__\": \"input_bam\",\n \"reference_genome\": \"human_g1k_v37_decoy\",\n \"sample_id\": \"HCC1143_20M\",\n \"case_id\": \"CCLE-HCC1143\",\n \"investigation\": \"CCLE-BRCA\",\n \"sample_type\": \"Cell Line\",\n \"experimental_strategy\": \"RNA-Seq\",\n \"platform\": \"Illumina\",\n \"quality_scale\": \"sanger\",\n \"species\": \"Homo sapiens\",\n \"sbg_public_files_category\": \"test\"\n}", "language": "json" } ], "sidebar": true } [/block]