{"__v":1,"_id":"56fd9ad95a08190e0008500c","category":{"__v":92,"_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","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-09-17T17:34:34.937Z","from_sync":false,"order":26,"slug":"api","title":"API Reference"},"parentDoc":null,"project":"55faf11ba62ba1170021a9a7","user":"5613e4f8fdd08f2b00437620","version":{"__v":35,"_id":"55faf11ba62ba1170021a9aa","project":"55faf11ba62ba1170021a9a7","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"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-03-31T21:47:05.704Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"get","results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":46,"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://cgc-api.sbgenomics.com/v2/upload/multipart/{upload_id}/part/{part_number}\",\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/upload/multipart/ezBaGmsWvyLwLjDdw3WNXXfs0EK4GpcHXijP37fP7o1jbdh24IAFEF7New5wYyli/part/1 HTTP/1.1\\nHost: cgc-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://cgc-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 CGC [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 CGC-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\": \"The timestamp in Coordinated Universal Time (UTC) by when the HTTP part upload request should be made.\\n\\n**Warning:** this timestamp includes microseconds. If your programming environment prefers second-based UTC timestamp format (also known as _UNIX time_, _POSIX time_ or _epoch time_), simply divide this number by 1000.\",\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]","excerpt":"/upload/multipart/{upload_id}/part/{part_number}","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}

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://cgc-api.sbgenomics.com/v2/upload/multipart/{upload_id}/part/{part_number}", "language": "text", "name": "Path" } ] } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "GET /v2/upload/multipart/ezBaGmsWvyLwLjDdw3WNXXfs0EK4GpcHXijP37fP7o1jbdh24IAFEF7New5wYyli/part/1 HTTP/1.1\nHost: cgc-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://cgc-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 CGC [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 CGC-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": "The timestamp in Coordinated Universal Time (UTC) by when the HTTP part upload request should be made.\n\n**Warning:** this timestamp includes microseconds. If your programming environment prefers second-based UTC timestamp format (also known as _UNIX time_, _POSIX time_ or _epoch time_), simply divide this number by 1000.", "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]