{"_id":"5774ee3fece8a00e00a15916","parentDoc":null,"__v":6,"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"},"githubsync":"","project":"5773dcfc255e820e00e1cd4d","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"},"user":"575e85ac41c8ba0e00259a44","metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-06-30T10:02:39.775Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"post","results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":55,"body":"This call allows you to report the upload multiple file parts at once.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cavatica-api.sbgenomics.com/v2/upload/multipart/{upload_id}\",\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/EXAMPLE_ID HTTP/1.1\\nHost: cavatica-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\\n\\n{\\n  \\\"parts\\\": [\\n    {\\n      \\\"part_number\\\": 1,\\n      \\\"response\\\": {\\n        \\\"headers\\\": {\\n          \\\"ETag\\\": \\\"9f1b6da2989615a414e8b00a27d20b0c\\\"\\n        }\\n      }\\n    }\\n  ]\\n}\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl --data ':::at:::report_parts.json' -s -H \\\"X-SBG-Auth-Token: 7942f56901534434a054dafc3813bc96\\\" -H \\\"content-type: application/json\\\" -X POST \\\"https://cavatica-api.sbgenomics.com/v2/upload/multipart/EXAMPLE_ID\\\"\",\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    \"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 key-value pairs describing the task. 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\": \"`parts`\",\n    \"0-1\": \"Array of Objects\",\n    \"0-2\": \"This key should contain an array of objects describing the individual part upload reports. Each of these objects should be formatted exactly as the whole body of the [Report an uploaded part](doc:report-an-uploaded-file-part) call.\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n###Example request body\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"parts\\\": [\\n    {\\n      \\\"part_number\\\": 1,\\n      \\\"response\\\": {\\n        \\\"headers\\\": {\\n          \\\"ETag\\\": \\\"9f1b6da2989615a414e8b00a27d20b0c\\\"\\n        }\\n      }\\n    },\\n    {\\n      \\\"part_number\\\": 2,\\n      \\\"response\\\": {\\n        \\\"headers\\\": {\\n          \\\"ETag\\\": \\\"266f8e5c06b6cc1495646fc48b3f2f0e\\\"\\n        }\\n      }\\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>","excerpt":"/upload/multipart/{upload_id}\n\nFor general information on the API, including formatting, parameters, and pagination, please see the [API Overview](the-api).","slug":"report-uploaded-parts","type":"endpoint","title":"Report uploaded parts"}

postReport uploaded parts

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

This call allows you to report the upload multiple file parts at once. [block:code] { "codes": [ { "code": "https://cavatica-api.sbgenomics.com/v2/upload/multipart/{upload_id}", "language": "text", "name": "API path" } ] } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "POST /v2/upload/multipart/EXAMPLE_ID HTTP/1.1\nHost: cavatica-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\n\n{\n \"parts\": [\n {\n \"part_number\": 1,\n \"response\": {\n \"headers\": {\n \"ETag\": \"9f1b6da2989615a414e8b00a27d20b0c\"\n }\n }\n }\n ]\n}", "language": "http", "name": null }, { "code": "curl --data '@report_parts.json' -s -H \"X-SBG-Auth-Token: 7942f56901534434a054dafc3813bc96\" -H \"content-type: application/json\" -X POST \"https://cavatica-api.sbgenomics.com/v2/upload/multipart/EXAMPLE_ID\"", "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": { "h-0": "Name", "h-1": "Description", "0-0": "`upload_id`", "0-1": "The ID for the upload, returned by the call to [initialize a multipart upload](doc:initialize-a-multipart-upload)." }, "cols": 2, "rows": 1 } [/block] ##Request body In the body of the request, you should enter key-value pairs describing the task. The keys, and their permitted values, are described below. [block:parameters] { "data": { "h-0": "Key", "h-1": "Datatype of value", "h-2": "Description of value", "0-0": "`parts`", "0-1": "Array of Objects", "0-2": "This key should contain an array of objects describing the individual part upload reports. Each of these objects should be formatted exactly as the whole body of the [Report an uploaded part](doc:report-an-uploaded-file-part) call." }, "cols": 3, "rows": 1 } [/block] ###Example request body [block:code] { "codes": [ { "code": "{\n \"parts\": [\n {\n \"part_number\": 1,\n \"response\": {\n \"headers\": {\n \"ETag\": \"9f1b6da2989615a414e8b00a27d20b0c\"\n }\n }\n },\n {\n \"part_number\": 2,\n \"response\": {\n \"headers\": {\n \"ETag\": \"266f8e5c06b6cc1495646fc48b3f2f0e\"\n }\n }\n }\n ]\n}", "language": "json" } ] } [/block] ##Response [See a list of Cavatica-specific response codes that may be contained in the body of the response.](doc:api-status-codes) <div align="right"><a href="#top">top</a></div> <hr>