{"_id":"5b0e13ffc4664e0003c75bdd","__v":0,"category":{"_id":"5b0e13ffc4664e0003c75a75","project":"5b0e13ffc4664e0003c75a66","version":"5b0e13ffc4664e0003c75a67","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-09-17T17:34:34.937Z","from_sync":false,"order":32,"slug":"api","title":"API Reference"},"project":"5b0e13ffc4664e0003c75a66","version":{"_id":"5b0e13ffc4664e0003c75a67","project":"5b0e13ffc4664e0003c75a66","__v":4,"createdAt":"2015-09-17T16:58:03.490Z","releaseDate":"2015-09-17T16:58:03.490Z","categories":["5b0e13ffc4664e0003c75a68","5b0e13ffc4664e0003c75a69","5b0e13ffc4664e0003c75a6a","5b0e13ffc4664e0003c75a6b","5b0e13ffc4664e0003c75a6c","5b0e13ffc4664e0003c75a6d","5b0e13ffc4664e0003c75a6e","5b0e13ffc4664e0003c75a6f","5b0e13ffc4664e0003c75a70","5b0e13ffc4664e0003c75a71","5b0e13ffc4664e0003c75a72","5b0e13ffc4664e0003c75a73","5b0e13ffc4664e0003c75a74","5b0e13ffc4664e0003c75a75","5b0e13ffc4664e0003c75a76","5b0e13ffc4664e0003c75a77","5b0e13ffc4664e0003c75a89","5b0e13ffc4664e0003c75a8a","5b0e13ffc4664e0003c75a9d","5b0e13ffc4664e0003c75a9e","5b0e13ffc4664e0003c75a9f","5b0e13ffc4664e0003c75aa0","5b0e13ffc4664e0003c75aa1","5b0e13ffc4664e0003c75aa2","5b0e13ffc4664e0003c75aa3","5b0e13ffc4664e0003c75aa4","5b0e13ffc4664e0003c75aa5","5b0e13ffc4664e0003c75aa6","5b0e13ffc4664e0003c75aa7","5b0e13ffc4664e0003c75aa8","5b0e13ffc4664e0003c75aa9","5b0e13ffc4664e0003c75aaa","5b0e13ffc4664e0003c75aab","5b0e13ffc4664e0003c75aac","5b0e13ffc4664e0003c75aad","5b0e13ffc4664e0003c75aae","5b0e13ffc4664e0003c75aaf","5b0e13ffc4664e0003c75ab2","5bb3374f4306ad0003eb18e7","5bbf3c5373e72a000318362b","5bc065567d1cb0000384c649","5cbf19a5f9181f0033fbb968"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"parentDoc":null,"user":"5613e4f8fdd08f2b00437620","githubsync":"","metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-03-31T21:47:05.704Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","examples":{"codes":[]},"method":"get","auth":"required","params":[],"url":""},"isReference":true,"order":45,"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://f4c-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: f4c-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://f4c-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 [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 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://f4c-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: f4c-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://f4c-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 [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 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]