{"_id":"5dc157751ed8850064bf9419","project":"5773dcfc255e820e00e1cd4d","version":{"_id":"5773dcfc255e820e00e1cd50","__v":27,"project":"5773dcfc255e820e00e1cd4d","createdAt":"2016-06-29T14:36:44.812Z","releaseDate":"2016-06-29T14:36:44.812Z","categories":["5773dcfc255e820e00e1cd51","5773df36904b0c0e00ef05ff","577baf92451b1e0e006075ac","577bb183b7ee4a0e007c4e8d","577ce77a1cf3cb0e0048e5ea","577d11865fd4de0e00cc3dab","578e62792c3c790e00937597","578f4fd98335ca0e006d5c84","578f5e5c3d04570e00976ebb","57bc35f7531e000e0075d118","57f801b3760f3a1700219ebb","5804d55d1642890f00803623","581c8d55c0dc651900aa9350","589dcf8ba8c63b3b00c3704f","594cebadd8a2f7001b0b53b2","59a562f46a5d8c00238e309a","5a2aa096e25025003c582b58","5a2e79566c771d003ca0acd4","5a3a5166142db90026f24007","5a3a52b5bcc254001c4bf152","5a3a574a2be213002675c6d2","5a3a66bb2be213002675cb73","5a3a6e4854faf60030b63159","5c8a68278e883901341de571","5cb9971e57bf020024523c7b","5cbf1683e2a36d01d5012ecd","5dc15666a4f788004c5fd7d7"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"5dc15666a4f788004c5fd7d7","project":"5773dcfc255e820e00e1cd4d","version":"5773dcfc255e820e00e1cd50","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2019-11-05T11:00:54.262Z","from_sync":false,"order":17,"slug":"drs-api","title":"DRS API"},"user":"566590c83889610d0008a253","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-11-05T11:05:25.493Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":999,"body":"This call will return a URL for downloading a file.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Please note that a different endpoint is used for the purpose of retrieving information about a DRS object (https://cavatica-ga4gh-api.sbgenomics.com/ga4gh/drs/v1/).\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cavatica-ga4gpi.sbgenomics.com/ga4gh/drs/v1/objects/{object_id}/access/{access_id}\",\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 ga4gh/drs/v1/objects/5c24cd21e4b08832c2f94e9c/access/aws-us-east-1 HTTP/1.1\\nHost: cavatica-ga4gh-api.sbgenomics.com\\nAuthorization: Bearer 3cfa44f5d2d4418b88018e88b795189b\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"GET /ga4gh/drs/v1/objects/5c24cd21e4b08832c2f94e9/access/aws-us-east-1c HTTP/1.1\\nHost: cavatica-ga4gh-api.sbgenomics.com\\nAuthorization: Bearer 3cfa44f5d2d4318b88018e98b795189b\\nHost: cavatica-ga4gh-api.sbgenomics.com\",\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\": \"Key\",\n    \"h-1\": \"Description of value\",\n    \"0-0\": \"`Authorization`\\n_required_\",\n    \"0-1\": \"Your Cavatica [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    \"h-0\": \"Key\",\n    \"h-1\": \"Description of value\",\n    \"h-2\": \"Description of value\",\n    \"0-0\": \"`object_id`\",\n    \"0-1\": \"The ID of the DRS object i.e. the ID of the file in your project.\",\n    \"0-2\": \"If true and a file exists in the given location on the volume (respecting volume prefix if given), the API will attempt to delete the existing file on the volume before exporting.\\n\\n_default_: `false`\",\n    \"1-0\": \"`access_id`\",\n    \"1-1\": \"An arbitrary string to be passed to the /access method to get an AccessURL.\\n\\nNote: use the [Get info about a DRS object](doc:get-info-about-a-drs-object) call to retrieve the `access_id`parameter.\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n##Response\n\n[See a list of Cavatica-specific response codes that may be contained in the body of the response](doc:api-status-codes). \n\n###Response body\n\nThe response object contains the link for downloading the file.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Key\",\n    \"h-1\": \"Data type of value\",\n    \"h-2\": \"Description of value\",\n    \"0-0\": \"`url`\",\n    \"0-1\": \"String\",\n    \"0-2\": \"The link for downloading the file.\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n###Example response body\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"url\\\": \\\"https://tcga-controlled.s3.amazonaws.com/3a5968d3-2a4f-415a-9b01-7f9f9afbad9f/7ee5a028a6bc0812b1b10aec200b57ac_gdc_realn.bam?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAINBJ6QVTSWMR7UZQ%2F20191029%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20191029T141056Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&user_id=436&username=ALEKSANDARGAZIBARA&X-Amz-Signature=af07361682c2b11a6537c99152b3e6e9d1198cafd9ee0bedcc4ae989d22de768\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example response body\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","slug":"get-an-url-for-downloading-a-file","type":"basic","title":"Get an URL for downloading a file"}

Get an URL for downloading a file


This call will return a URL for downloading a file. [block:callout] { "type": "info", "body": "Please note that a different endpoint is used for the purpose of retrieving information about a DRS object (https://cavatica-ga4gh-api.sbgenomics.com/ga4gh/drs/v1/)." } [/block] [block:code] { "codes": [ { "code": "https://cavatica-ga4gpi.sbgenomics.com/ga4gh/drs/v1/objects/{object_id}/access/{access_id}", "language": "text", "name": "Path" } ] } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "GET ga4gh/drs/v1/objects/5c24cd21e4b08832c2f94e9c/access/aws-us-east-1 HTTP/1.1\nHost: cavatica-ga4gh-api.sbgenomics.com\nAuthorization: Bearer 3cfa44f5d2d4418b88018e88b795189b", "language": "http", "name": null }, { "code": "GET /ga4gh/drs/v1/objects/5c24cd21e4b08832c2f94e9/access/aws-us-east-1c HTTP/1.1\nHost: cavatica-ga4gh-api.sbgenomics.com\nAuthorization: Bearer 3cfa44f5d2d4318b88018e98b795189b\nHost: cavatica-ga4gh-api.sbgenomics.com", "language": "curl", "name": "cURL" } ], "sidebar": true } [/block] ###Header Fields [block:parameters] { "data": { "h-0": "Key", "h-1": "Description of value", "0-0": "`Authorization`\n_required_", "0-1": "Your Cavatica [authentication token](doc:get-your-authentication-token).", "h-2": "" }, "cols": 2, "rows": 1 } [/block] ###Path parameters [block:parameters] { "data": { "h-0": "Key", "h-1": "Description of value", "h-2": "Description of value", "0-0": "`object_id`", "0-1": "The ID of the DRS object i.e. the ID of the file in your project.", "0-2": "If true and a file exists in the given location on the volume (respecting volume prefix if given), the API will attempt to delete the existing file on the volume before exporting.\n\n_default_: `false`", "1-0": "`access_id`", "1-1": "An arbitrary string to be passed to the /access method to get an AccessURL.\n\nNote: use the [Get info about a DRS object](doc:get-info-about-a-drs-object) call to retrieve the `access_id`parameter." }, "cols": 2, "rows": 2 } [/block] ##Response [See a list of Cavatica-specific response codes that may be contained in the body of the response](doc:api-status-codes). ###Response body The response object contains the link for downloading the file. [block:parameters] { "data": { "h-0": "Key", "h-1": "Data type of value", "h-2": "Description of value", "0-0": "`url`", "0-1": "String", "0-2": "The link for downloading the file." }, "cols": 3, "rows": 1 } [/block] ###Example response body [block:code] { "codes": [ { "code": "{\n \"url\": \"https://tcga-controlled.s3.amazonaws.com/3a5968d3-2a4f-415a-9b01-7f9f9afbad9f/7ee5a028a6bc0812b1b10aec200b57ac_gdc_realn.bam?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAINBJ6QVTSWMR7UZQ%2F20191029%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20191029T141056Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&user_id=436&username=ALEKSANDARGAZIBARA&X-Amz-Signature=af07361682c2b11a6537c99152b3e6e9d1198cafd9ee0bedcc4ae989d22de768\"\n}", "language": "json", "name": "Example response body" } ], "sidebar": true } [/block]