{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","params":[],"results":{"codes":[]},"settings":"","examples":{"codes":[]},"method":"post"},"next":{"description":"","pages":[]},"title":"Report an uploaded part","type":"endpoint","slug":"report-an-uploaded-part","excerpt":"/upload/multipart/{upload_id}/part\n\nFor general information on the API, including formatting, parameters, and pagination, please see the [API Overview](the-api).","body":"This call allows you to report the upload of a file part.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cavatica-api.sbgenomics.com/v2/upload/multipart/{upload_id}/part\",\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\": \"POST /v2/upload/multipart/ezBaGmsWvyLwLjDdw3WNXXfs0EK4GpcHXijP37fP7o1jbdh24IAFEF7New5wYyli/part HTTP/1.1\\nHost: cavatica-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://cavatica-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 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\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](doc:get-the-upload-url-for-a-file-part). Assuming 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-the-upload-url-for-a-file-part), and their values should be strings that you have collected from the HTTP part upload 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 Cavatica-specific response codes that may be contained in the body of the response.](doc:api-status-codes) \n\n<div align=\"right\"><a href=\"#top\">top</a></div>\n\n<hr>","updates":[],"order":54,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5774ed6083b09919004a47eb","project":"5773dcfc255e820e00e1cd4d","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"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","5eaff69e844d67003642a020","5eb00899b36ba5002d35b0c1","5eb0172be179b70073dc936e","5eb01b42b36ba5002d35ebba","5eb01f202654a20136813093","5eb918ef149186021c9a76c8","5f0839d3f4b24e005ebbbc29","5f893e508c9862002d0614a9"],"_id":"5773dcfc255e820e00e1cd50","__v":35,"createdAt":"2016-06-29T14:36:44.812Z","releaseDate":"2016-06-29T14:36:44.812Z","project":"5773dcfc255e820e00e1cd4d"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Cavatica API","slug":"api","order":18,"from_sync":false,"reference":false,"_id":"5773df36904b0c0e00ef05ff","createdAt":"2016-06-29T14:46:14.277Z","version":"5773dcfc255e820e00e1cd50","__v":0,"project":"5773dcfc255e820e00e1cd4d"},"createdAt":"2016-06-30T09:58:56.052Z","parentDoc":null,"user":"575e85ac41c8ba0e00259a44","__v":5,"githubsync":""}