{"_id":"5b0e13ffc4664e0003c75c80","parentDoc":null,"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"},"__v":1,"user":"5613e4f8fdd08f2b00437620","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","githubsync":"","metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-03-31T21:49:47.748Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","examples":{"codes":[]},"method":"post","auth":"required","params":[],"url":""},"isReference":true,"order":46,"body":"This call allows you to report the upload of a file part.\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"https://f4c-api.sbgenomics.com/v2/upload/multipart/{upload_id}/part\",\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\": \"POST /v2/upload/multipart/ezBaGmsWvyLwLjDdw3WNXXfs0EK4GpcHXijP37fP7o1jbdh24IAFEF7New5wYyli/part HTTP/1.1\\nHost: f4c-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\\n\\n{\\n \\\"part_number\\\": 1,\\n \\\"response\\\": {\\n \\\"headers\\\": {\\n \\\"ETag\\\": \\\"be96ac61fa156d2d71ae61608f992554\\\"\\n }\\n }\\n}\",\n \"language\": \"http\",\n \"name\": null\n },\n {\n \"code\": \"curl --data '{\\\"part_number\\\": 1, \\\"response\\\": {\\\"headers\\\": {\\\"ETag\\\": \\\"be96ac61fa156d2d71ae61608f992554\\\"}}}' -s -H \\\"X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\\\" -H \\\"content-type: application/json\\\" -X POST \\\"https://f4c-api.sbgenomics.com/v2/upload/multipart/ezBaGmsWvyLwLjDdw3WNXXfs0EK4GpcHXijP37fP7o1jbdh24IAFEF7New5wYyli/part\\\"\",\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\n###Path parameters\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Name\",\n \"h-1\": \"Description\",\n \"0-0\": \"`upload_id`\",\n \"0-1\": \"The ID for the upload, returned by the call to [initialize a multipart upload](doc:initialize-a-multipart-upload).\"\n },\n \"cols\": 2,\n \"rows\": 1\n}\n[/block]\n##Request body\nIn the body of the request, you should enter a JSON object key-value pairs describing the report. The keys, and their permitted values, are described below.\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Key\",\n \"h-1\": \"Datatype of value\",\n \"h-2\": \"Description of value\",\n \"0-0\": \"`part_number`\",\n \"0-1\": \"Integer\",\n \"1-0\": \"`response`\",\n \"1-1\": \"Object\",\n \"0-2\": \"The number of the file part you are reporting. Part numbers start from 1.\",\n \"1-2\": \"This object should contain the information collected from a successful HTTP part upload request.\\nSee the [Formatting the `response` object](#section-formatting-the-response-object) section below for an explanation of its structure.\"\n },\n \"cols\": 3,\n \"rows\": 2\n}\n[/block]\n##Formatting the `response` object\nWhen reporting a part, the structure of the `response` object is different from that of the `report` object received when [getting a part upload URL](http://docs.cancergenomicscloud.org/docs/get-upload-url-for-a-file-part).\n\nAssuming that you have collected the information from the HTTP part upload request, you should format the `response` object in this call as a set of key-value mappings. The keys in these mappings should be headers and other response elements described in [Get upload URL for a file part](doc:get-upload-url-for-a-file-part), and their values should be strings that you have collected from the HTTP part upload request.\n\nSee the example below for an illustration of how to format a part report request.\n[block:parameters]\n{\n \"data\": {\n \"0-0\": \"`headers`\",\n \"1-0\": \"`body`\",\n \"h-0\": \"Key\",\n \"h-1\": \"Datatype of value\",\n \"h-2\": \"Description of value\",\n \"0-1\": \"Object of string keys to string values\",\n \"1-1\": \"Object\",\n \"1-2\": \"*Reserved for future use*\",\n \"0-2\": \"A map of header keys from the [Get upload URL for a file part](doc:get-the-upload-url-for-a-file-part) to their values returned by the successful HTTP part upload request you've made.\"\n },\n \"cols\": 3,\n \"rows\": 2\n}\n[/block]\n###Example request body\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"{\\n \\\"part_number\\\": 1,\\n \\\"response\\\": {\\n \\\"headers\\\": {\\n \\\"ETag\\\": \\\"be96ac61fa156d2d71ae61608f992554\\\"\\n }\\n }\\n}\",\n \"language\": \"json\"\n }\n ]\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###Example response body\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"HTTP/1.1 200 OK\\nDate: Tue, 29 Mar 2016 16:36:45 GMT\\nContent-Type: application/json\\nConnection: close\\n\",\n \"language\": \"http\"\n }\n ],\n \"sidebar\": true\n}\n[/block]","excerpt":"/upload/multipart/{upload_id}/part","slug":"report-an-uploaded-part","type":"endpoint","title":"Report an uploaded part"}
postReport an uploaded part
/upload/multipart/{upload_id}/part