{"_id":"5774ed2250a4121900e4a2ac","user":"575e85ac41c8ba0e00259a44","githubsync":"","parentDoc":null,"project":"5773dcfc255e820e00e1cd4d","__v":2,"category":{"_id":"5773df36904b0c0e00ef05ff","version":"5773dcfc255e820e00e1cd50","__v":0,"project":"5773dcfc255e820e00e1cd4d","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-06-29T14:46:14.277Z","from_sync":false,"order":12,"slug":"api","title":"Cavatica API"},"version":{"_id":"5773dcfc255e820e00e1cd50","__v":26,"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"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-06-30T09:57:54.585Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","examples":{"codes":[]},"method":"get","auth":"required","params":[],"url":""},"isReference":false,"order":53,"body":"This call returns the signed URL required to upload a part of a multipart upload. Once you have obtained this URL for your file part, you can make a `PUT` request to it with the file part as the request body.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cavatica-api.sbgenomics.com/v2/upload/multipart/{upload_id}/part/{part_number}\",\n      \"language\": \"text\",\n      \"name\": \"APi path\"\n    }\n  ]\n}\n[/block]\n##Request\n\n###Example request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /v2/upload/multipart/ezBaGmsWvyLwLjDdw3WNXXfs0EK4GpcHXijP37fP7o1jbdh24IAFEF7New5wYyli/part/1 HTTP/1.1\\nHost: cavatica-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\\n\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl -s -H \\\"X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\\\" -H \\\"content-type: application/json\\\" -X GET \\\"https://cavatica-api.sbgenomics.com/v2/upload/multipart/EXAMPLE_ID/part/1\\\"\",\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 Cavatica [authentication token](doc:get-your-authentication-token).\",\n    \"h-2\": \"\",\n    \"1-0\": \"`Content-Type`\\n_required_\",\n    \"1-1\": \"`application/json`\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n###Path parameters\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`upload_id`\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-1\": \"The ID for the upload, returned by the call to [initialize a multipart upload](doc:initialize-a-multipart-upload).\",\n    \"1-0\": \"`part_number`\",\n    \"1-1\": \"The number of the file part you are uploading. Part numbers start from 1.\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n##Response\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\nThe response object contains information about the URL to which you should upload the file part. The information is structured using the following key-value pairs:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Key\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`method`\",\n    \"0-1\": \"String\",\n    \"1-0\": \"`url`\",\n    \"1-1\": \"String\",\n    \"2-0\": \"`expires`\",\n    \"2-1\": \"Integer\",\n    \"3-0\": \"`headers`\",\n    \"3-1\": \"Object\",\n    \"4-0\": \"`report`\",\n    \"4-1\": \"Object\",\n    \"5-0\": \"`success_codes`\",\n    \"5-1\": \"Array of Integers\",\n    \"4-2\": \"See the [Structure of the `report` object](#section-structure-of-the-report-object) section below for an explanation of the `report` object.\",\n    \"5-2\": \"A list of status codes returned by the HTTP part upload request that should be recognized as success.\\nA successful part upload request should be reported back to the API in a call to [report an uploaded file part](doc:report-an-uploaded-file-part) by passing the information collected from the `report` object.\",\n    \"3-2\": \"A map of headers and values that should be set when making the HTTP part upload request.\",\n    \"2-2\": \"ISO 8601 combined date and time representation in Coordinated Universal Time (UTC) by when the HTTP part upload request should be made.\",\n    \"0-2\": \"The HTTP method to use when making the HTTP part upload request.\",\n    \"1-2\": \"The URL to which to make the HTTP part upload request.\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]\n####Structure of the `report` object\nThis object instructs you which pieces of information need to be collected from a successful response to the HTTP part upload request.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Key\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`headers`\",\n    \"1-0\": \"`body`\",\n    \"0-2\": \"A list of HTTP headers whose values should be collected from a successful response to the HTTP part upload request.\",\n    \"0-1\": \"Array of Strings\",\n    \"1-1\": \"Object\",\n    \"1-2\": \"*Reserved for future use*\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n###Example response body\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"method\\\": \\\"PUT\\\",\\n  \\\"url\\\": \\\"https://sbg-vs2-devel.s3.amazonaws.com/aa8a1030-7e27-4da4-b42b-39658b795d61%2BCanFam3.1.dna_rm.toplevel.fa.gz?uploadId=lMllZ7WIWqHsCNj9IKV4VytwZOy0.4ZKFPDD73Cw6I745a3xFXKZLHrqDi0kZt0jTm25PYJqNfEJDF9OaJ6Xvg8vLv9K7SJ.RLiCczfy6ieGCJzNQd78vmSK3a9Bkgx2&partNumber=1&AWSAccessKeyId=AKIAJF4ANIHWSCZA724Q&Expires=1459113561&Signature=3myy2S6960C11jkmjX24WApZwNo%3D\\\",\\n  \\\"expires\\\": \\\"2016-02-27T15:55:38Z\\\",\\n  \\\"headers\\\": {},\\n  \\\"report\\\": {\\n    \\\"success_codes\\\": [\\n      200\\n    ],\\n    \\\"headers\\\": [\\n      \\\"ETag\\\"\\n    ]\\n  }\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n<div align=\"right\"><a href=\"#top\">top</a></div>\n\n<hr>","excerpt":"/upload/multipart/{upload_id}/part/{part_number}\n\nFor general information on the API, including formatting, parameters, and pagination, please see the [API Overview](the-api).","slug":"get-upload-url-for-a-file-part","type":"endpoint","title":"Get upload URL for a file part"}

getGet upload URL for a file part

/upload/multipart/{upload_id}/part/{part_number} For general information on the API, including formatting, parameters, and pagination, please see the [API Overview](the-api).

This call returns the signed URL required to upload a part of a multipart upload. Once you have obtained this URL for your file part, you can make a `PUT` request to it with the file part as the request body. [block:code] { "codes": [ { "code": "https://cavatica-api.sbgenomics.com/v2/upload/multipart/{upload_id}/part/{part_number}", "language": "text", "name": "APi path" } ] } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "GET /v2/upload/multipart/ezBaGmsWvyLwLjDdw3WNXXfs0EK4GpcHXijP37fP7o1jbdh24IAFEF7New5wYyli/part/1 HTTP/1.1\nHost: cavatica-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\n", "language": "http", "name": null }, { "code": "curl -s -H \"X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\" -H \"content-type: application/json\" -X GET \"https://cavatica-api.sbgenomics.com/v2/upload/multipart/EXAMPLE_ID/part/1\"", "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 Cavatica [authentication token](doc:get-your-authentication-token).", "h-2": "", "1-0": "`Content-Type`\n_required_", "1-1": "`application/json`" }, "cols": 2, "rows": 2 } [/block] ###Path parameters [block:parameters] { "data": { "0-0": "`upload_id`", "h-0": "Name", "h-1": "Description", "0-1": "The ID for the upload, returned by the call to [initialize a multipart upload](doc:initialize-a-multipart-upload).", "1-0": "`part_number`", "1-1": "The number of the file part you are uploading. Part numbers start from 1." }, "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 information about the URL to which you should upload the file part. The information is structured using the following key-value pairs: [block:parameters] { "data": { "h-0": "Key", "h-1": "Data type", "h-2": "Description", "0-0": "`method`", "0-1": "String", "1-0": "`url`", "1-1": "String", "2-0": "`expires`", "2-1": "Integer", "3-0": "`headers`", "3-1": "Object", "4-0": "`report`", "4-1": "Object", "5-0": "`success_codes`", "5-1": "Array of Integers", "4-2": "See the [Structure of the `report` object](#section-structure-of-the-report-object) section below for an explanation of the `report` object.", "5-2": "A list of status codes returned by the HTTP part upload request that should be recognized as success.\nA successful part upload request should be reported back to the API in a call to [report an uploaded file part](doc:report-an-uploaded-file-part) by passing the information collected from the `report` object.", "3-2": "A map of headers and values that should be set when making the HTTP part upload request.", "2-2": "ISO 8601 combined date and time representation in Coordinated Universal Time (UTC) by when the HTTP part upload request should be made.", "0-2": "The HTTP method to use when making the HTTP part upload request.", "1-2": "The URL to which to make the HTTP part upload request." }, "cols": 3, "rows": 6 } [/block] ####Structure of the `report` object This object instructs you which pieces of information need to be collected from a successful response to the HTTP part upload request. [block:parameters] { "data": { "h-0": "Key", "h-1": "Data type", "h-2": "Description", "0-0": "`headers`", "1-0": "`body`", "0-2": "A list of HTTP headers whose values should be collected from a successful response to the HTTP part upload request.", "0-1": "Array of Strings", "1-1": "Object", "1-2": "*Reserved for future use*" }, "cols": 3, "rows": 2 } [/block] ###Example response body [block:code] { "codes": [ { "code": "{\n \"method\": \"PUT\",\n \"url\": \"https://sbg-vs2-devel.s3.amazonaws.com/aa8a1030-7e27-4da4-b42b-39658b795d61%2BCanFam3.1.dna_rm.toplevel.fa.gz?uploadId=lMllZ7WIWqHsCNj9IKV4VytwZOy0.4ZKFPDD73Cw6I745a3xFXKZLHrqDi0kZt0jTm25PYJqNfEJDF9OaJ6Xvg8vLv9K7SJ.RLiCczfy6ieGCJzNQd78vmSK3a9Bkgx2&partNumber=1&AWSAccessKeyId=AKIAJF4ANIHWSCZA724Q&Expires=1459113561&Signature=3myy2S6960C11jkmjX24WApZwNo%3D\",\n \"expires\": \"2016-02-27T15:55:38Z\",\n \"headers\": {},\n \"report\": {\n \"success_codes\": [\n 200\n ],\n \"headers\": [\n \"ETag\"\n ]\n }\n}", "language": "json" } ], "sidebar": true } [/block] <div align="right"><a href="#top">top</a></div> <hr>