{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"Download a DRS object (file) tutorial","type":"basic","slug":"download-a-file-tutorial","excerpt":"","body":"This tutorial will demonstrate how you can download an example file via DRS API. You can download any type of file, public or controlled, as long as:\n\n* it resides in your project\n* you have copy permission\n* and proper authorization\n\nTo download a file using DRS API:\n\n1. [Create](doc:create-a-new-project) a new project.\n2. For the purpose of this example we will [add a public file](doc:copy-files-to-a-project) by accessing the **Public files** tab and searching for `example_human_reference.fasta`.\n3. [Copy the file](doc:copy-files-to-a-project) to your project. In addition:\n * The DRS ID is equal to the file ID on the Seven Bridges Platform (5dc018a9e4b0bf4ae31e92fc for this one).\n * The file ID is an integral part of the URL once you access the page with file details).\n * The DRS endpoint is https://cgc-ga4gh-api.sbgenomics.com/ga4gh/drs/v1/\n4. Obtain the authentication token from: https://cgc.sbgenomics.com/developer#token and include it in the API call.\n5. Perform the following API call:\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"'$ curl -H \\\"X-SBG-Auth-Token: <token>\\\" 'https://cgc-ga4gh-api.sbgenomics.com/ga4gh/drs/v1/objects/5d728923e4b09cae86687385'\\n\",\n \"language\": \"json\"\n }\n ]\n}\n[/block]\nThe response will contain the `access_id` parameter, which you will use within the API call for retrieving the URL for downloading the file. \n\n6. Perform the API call for obtaining the URL using the '`access_id`.\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"'$ curl -H \\\"X-SBG-Auth-Token: <token>\\\" 'https://cgc-ga4gh-api.sbgenomics.com/ga4gh/drs/v1/objects/5d728923e4b09cae86687385/access/aws-us-east-1'\\n\",\n \"language\": \"json\"\n }\n ]\n}\n[/block]\nThe response will contain the URL for downloading the file. \n\n7. Download the file.","updates":[],"order":3,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5dc020650eb9e0005aaf2987","project":"55faf11ba62ba1170021a9a7","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"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","5a2a81f688574d001e9934f5","5b080c8d7833b20003ddbb6f","5c222bed4bc358002f21459a","5c22412594a2a5005cc9e919","5c41ae1c33592700190a291e","5c8a525e2ba7b2003f9b153c","5cbf14d58c79c700ef2b502e","5db6f03a6e187c006f667fa4","5f894c7d3b0894006477ca01","6176d5bf8f59c6001038c2f7"],"_id":"55faf11ba62ba1170021a9aa","releaseDate":"2015-09-17T16:58:03.490Z","createdAt":"2015-09-17T16:58:03.490Z","project":"55faf11ba62ba1170021a9a7","__v":48},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"DRS API","slug":"drs-api","order":39,"from_sync":false,"reference":false,"_id":"5db6f03a6e187c006f667fa4","project":"55faf11ba62ba1170021a9a7","version":"55faf11ba62ba1170021a9aa","createdAt":"2019-10-28T13:42:18.754Z","__v":0},"user":"566590c83889610d0008a253","createdAt":"2019-11-04T12:58:13.283Z","__v":0,"parentDoc":null}