{"_id":"568cff0274c77f2d00d56d51","parentDoc":null,"__v":5,"project":"55faf11ba62ba1170021a9a7","user":"554340dfb7f4540d00fcef1d","version":{"_id":"55faf11ba62ba1170021a9aa","project":"55faf11ba62ba1170021a9a7","__v":38,"createdAt":"2015-09-17T16:58:03.490Z","releaseDate":"2015-09-17T16:58:03.490Z","categories":["55faf11ca62ba1170021a9ab","55faf8f4d0e22017005b8272","55faf91aa62ba1170021a9b5","55faf929a8a7770d00c2c0bd","55faf932a8a7770d00c2c0bf","55faf94b17b9d00d00969f47","55faf958d0e22017005b8274","55faf95fa8a7770d00c2c0c0","55faf96917b9d00d00969f48","55faf970a8a7770d00c2c0c1","55faf98c825d5f19001fa3a6","55faf99aa62ba1170021a9b8","55faf99fa62ba1170021a9b9","55faf9aa17b9d00d00969f49","55faf9b6a8a7770d00c2c0c3","55faf9bda62ba1170021a9ba","5604570090ee490d00440551","5637e8b2fbe1c50d008cb078","5649bb624fa1460d00780add","5671974d1b6b730d008b4823","5671979d60c8e70d006c9760","568e8eef70ca1f0d0035808e","56d0a2081ecc471500f1795e","56d4a0adde40c70b00823ea3","56d96b03dd90610b00270849","56fbb83d8f21c817002af880","573c811bee2b3b2200422be1","576bc92afb62dd20001cda85","5771811e27a5c20e00030dcd","5785191af3a10c0e009b75b0","57bdf84d5d48411900cd8dc0","57ff5c5dc135231700aed806","5804caf792398f0f00e77521","58458b4fba4f1c0f009692bb","586d3c287c6b5b2300c05055","58ef66d88646742f009a0216","58f5d52d7891630f00fe4e77","59a555bccdbd85001bfb1442"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"55faf9aa17b9d00d00969f49","pages":["56312d239ead230d00a188f2","56312e0d82d96a0d00b0fb08","56315777fc94aa0d00e9b553","56315b779ead230d00a1894a","5631657c9c25801700dac34f","56317884fc94aa0d00e9b586","56318386c3b04b0d00ba9bb9","563240ccdcc27a170082363b","563240dfbddb091700ad5e82","563240edfe9acd1900cc1d10","56324504fa40240d007c8d5f","56324b30c3b04b0d00ba9c96","563273ae45f2cb0d006be3fa","563273c08c9cda0d0025266d","563273cc38f8aa0d00d30f55","563273d838f8aa0d00d30f59","5632740945f2cb0d006be3fc","56327411df556c0d00cd0905","5632741b8c9cda0d0025266f","563274ea10b6040d008793d8","5632757cdf556c0d00cd0908","563275b710b6040d008793da","563275f938f8aa0d00d30f60","5632762fb904a10d0032f6fc","5632767110b6040d008793dd","563276c0b904a10d0032f700","5632770162c48a0d00334d53","5632843d8c9cda0d00252698","5632846e62c48a0d00334d78","56328a7e49e16d0d00122420","56328aaf49e16d0d00122425","56328b2238f8aa0d00d30f88","56328b6c8c9cda0d002526a2","56328c0710b6040d008793ff","56328c3710b6040d00879401","56328c5938f8aa0d00d30f8c","56328c90b904a10d0032f722","56328cc449e16d0d0012242a","56328ce68c9cda0d002526a8","56328d1338f8aa0d00d30f8e","56328d5810b6040d00879407","56328d7cdf556c0d00cd092f","56328d9a10b6040d00879409","56328db438f8aa0d00d30f92","56328dd762c48a0d00334d8b","56328df649e16d0d0012242d","56328e1edf556c0d00cd0931","56328e4662c48a0d00334d8e","56328e5edf556c0d00cd0933","56328e8f8c9cda0d002526ab","56328eb3b904a10d0032f72a","56328edb38f8aa0d00d30f95","56328ef210b6040d0087940d","56328f148c9cda0d002526ad","56328f2962c48a0d00334d90","56328f54b904a10d0032f72c","56328f6c38f8aa0d00d30f98","56328f858c9cda0d002526af","56328fae62c48a0d00334d95","56328fd838f8aa0d00d30f9c","5637f069ee0ee60d0024ec18","5641ffaa9417b40d00c0fc35","564355240d9748190079dea9","5644cfeb2c74cf1900da4831","56450f856b0ca50d00f6bd8f","56706537cbb2fb0d00f7c7dd","567065bc3d29830d00376213","56706fc2cbb2fb0d00f7c87e","568bf5a1e662f40d00eee866","568c0699e662f40d00eee881","568cff0274c77f2d00d56d51","568d10f58602880d001ce277","568d2abc37b636250036b904","568d343413c5ad0d00b34efb","568d593a8602880d001ce2d3","568e64135e12fb0d00325160","568e66f05e12fb0d00325162","568e78aa5e12fb0d0032517a","569433cfd8c04d1700e5ae0c","56943723d8c04d1700e5ae14","5694393b3e9d080d00f0655d","5694e6cf953b810d008f91bc","5694f301c5c5ce0d00058e68","569502ef9797fa1900f704e7","5695063bcaa32519009c40b3","569511cccaa32519009c40d9","569557e2fcb1032d0089dfe2","569562fefcb1032d0089dfee","56956428fe18811700c9c058","569639b87596a90d0014e5a3","56a90197e590350d004b5103","56a9021e9ec7660d002e08c2"],"project":"55faf11ba62ba1170021a9a7","version":"55faf11ba62ba1170021a9aa","__v":92,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-09-17T17:34:34.937Z","from_sync":false,"order":27,"slug":"api","title":"API Reference"},"updates":["56a5f0b2b91d8d0d008349d2"],"next":{"pages":[],"description":""},"createdAt":"2016-01-06T11:48:18.986Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"post","results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":105,"body":"This call allows you to get the download URL for a file.\n\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"This call is not intended for general CGC users\",\n  \"body\": \"To use this call, you should supply the file's `path`. This object is not available on the CGC. It is available from the [SPARQL query console](https://opensparql.sbgenomics.com), created by Seven Bridges, for exploring TCGA data. This API call is designed for users of that product. For more information on the SPARQL query console, please contact support:::at:::sbgenomics.com.\\n\\nThere is an alternative CGC API call to [get download information and URL for a file](doc:get-download-url-for-a-file). General CGC users should use that call instead of this one.\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cgc-api.sbgenomics.com/v2/action/files/get_download_url\",\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\": \"POST /v2/action/files/get_download_url HTTP/1.1\\nHost: cgc-api.sbgenomics.com\\nX-SBG-Auth-Token: 7942f56901534434a054dafc3813bc96\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl --data '{[\\\"/Projects/f3ab1a5d-a91d-4fb4-bc46-8e01ebc76a73/1000G_omni2.5.b37.vcf\\\"]}' -s -H \\\"X-SBG-Auth-Token: 7942f56901534434a054dafc3813bc96\\\" -H \\\"content-type: application/json\\\" -X POST \\\"https://cgc-api.sbgenomics.com/v2/action/files/get_download_url\\\"\",\n      \"language\": \"curl\",\n      \"name\": \"cURL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n##Request body\nIn the body, you should enter an array of strings, containing the file paths.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Body\",\n    \"h-1\": \"Data type of value\",\n    \"h-2\": \"Content of value\",\n    \"0-0\": \"array of strings, consisting of file paths.\",\n    \"0-1\": \"\",\n    \"0-2\": \"\"\n  },\n  \"cols\": 1,\n  \"rows\": 1\n}\n[/block]\n###Example request body\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"[\\\"/Datasets/tcga/TCGA-LUAD/ac0d7a82-82cb-4aec-b859-e37375f3de8b/analysis/1e849d63-a360-4d35-b9fe-745a3f0bf291/data/C509.TCGA-97-8547-01A-11D-2393-08.2.bam\\\"]\",\n      \"language\": \"json\"\n    }\n  ]\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 CGC [authentication token](doc:get-your-authentication-token).\",\n    \"h-2\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n##Response\n\n[See a list of CGC-specific 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    \\\"https://tcga-controlled-access.s3.amazonaws.com/TCGA-LUAD/ac0d7a82-82cb-4aec-b859-e37375f3de8b/analysis/1e849d63-a360-4d35-b9fe-745a3f0bf291/data/C509.TCGA-97-8547-01A-11D-2393-08.2.bam?response-content-disposition=attachment%3Bfilename%3DC509.TCGA-97-8547-01A-11D-2393-08.2.bam&response-content-type=application%2Foctet-stream&AWSAccessKeyId=AKIAKLDEXM5REGIZ56VA&Expires=1453888344&Signature=A3qF0fgIwXOP3tgYkMuwCQYQ%3D\\\"\\n]\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\nNote that if you submit an incorrect file path, the call will return the value `null`.","excerpt":"action/files/get_download_url","slug":"get-a-files-download-url","type":"endpoint","title":"Get a file's download URL"}

postGet a file's download URL

action/files/get_download_url

This call allows you to get the download URL for a file. [block:callout] { "type": "danger", "title": "This call is not intended for general CGC users", "body": "To use this call, you should supply the file's `path`. This object is not available on the CGC. It is available from the [SPARQL query console](https://opensparql.sbgenomics.com), created by Seven Bridges, for exploring TCGA data. This API call is designed for users of that product. For more information on the SPARQL query console, please contact support@sbgenomics.com.\n\nThere is an alternative CGC API call to [get download information and URL for a file](doc:get-download-url-for-a-file). General CGC users should use that call instead of this one." } [/block] [block:code] { "codes": [ { "code": "https://cgc-api.sbgenomics.com/v2/action/files/get_download_url", "language": "text", "name": "Path" } ] } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "POST /v2/action/files/get_download_url HTTP/1.1\nHost: cgc-api.sbgenomics.com\nX-SBG-Auth-Token: 7942f56901534434a054dafc3813bc96", "language": "http", "name": null }, { "code": "curl --data '{[\"/Projects/f3ab1a5d-a91d-4fb4-bc46-8e01ebc76a73/1000G_omni2.5.b37.vcf\"]}' -s -H \"X-SBG-Auth-Token: 7942f56901534434a054dafc3813bc96\" -H \"content-type: application/json\" -X POST \"https://cgc-api.sbgenomics.com/v2/action/files/get_download_url\"", "language": "curl", "name": "cURL" } ], "sidebar": true } [/block] ##Request body In the body, you should enter an array of strings, containing the file paths. [block:parameters] { "data": { "h-0": "Body", "h-1": "Data type of value", "h-2": "Content of value", "0-0": "array of strings, consisting of file paths.", "0-1": "", "0-2": "" }, "cols": 1, "rows": 1 } [/block] ###Example request body [block:code] { "codes": [ { "code": "[\"/Datasets/tcga/TCGA-LUAD/ac0d7a82-82cb-4aec-b859-e37375f3de8b/analysis/1e849d63-a360-4d35-b9fe-745a3f0bf291/data/C509.TCGA-97-8547-01A-11D-2393-08.2.bam\"]", "language": "json" } ] } [/block] ###Header Fields [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": "`X-SBG-Auth-Token`\n_required_", "0-1": "Your CGC [authentication token](doc:get-your-authentication-token).", "h-2": "" }, "cols": 2, "rows": 1 } [/block] ##Response [See a list of CGC-specific response codes that may be contained in the body of the response.](doc:api-status-codes) ###Example response body [block:code] { "codes": [ { "code": "[\n \"https://tcga-controlled-access.s3.amazonaws.com/TCGA-LUAD/ac0d7a82-82cb-4aec-b859-e37375f3de8b/analysis/1e849d63-a360-4d35-b9fe-745a3f0bf291/data/C509.TCGA-97-8547-01A-11D-2393-08.2.bam?response-content-disposition=attachment%3Bfilename%3DC509.TCGA-97-8547-01A-11D-2393-08.2.bam&response-content-type=application%2Foctet-stream&AWSAccessKeyId=AKIAKLDEXM5REGIZ56VA&Expires=1453888344&Signature=A3qF0fgIwXOP3tgYkMuwCQYQ%3D\"\n]", "language": "json" } ], "sidebar": true } [/block] Note that if you submit an incorrect file path, the call will return the value `null`.