{"_id":"5774ec988029ad0e00c39100","githubsync":"","parentDoc":null,"user":"575e85ac41c8ba0e00259a44","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"},"project":"5773dcfc255e820e00e1cd4d","version":{"_id":"5773dcfc255e820e00e1cd50","__v":27,"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","5dc15666a4f788004c5fd7d7"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"__v":3,"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-06-30T09:55:36.817Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","examples":{"codes":[]},"method":"get","auth":"required","params":[],"url":""},"isReference":false,"order":51,"body":"This call will return the details of an active multipart upload.\n\nThe upload is referenced by its ID as returned by a call to [initialize a multipart upload](doc:initialize-a-multipart-upload) or [list current multipart uploads](doc:list-current-multipart-uploads).\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\": \"GET /v2/upload/multipart/ezBaGmsWvyLwLjDdw3WNXXfs0EK4GpcHXijP37fP7o1jbdh24IAFEF7New5wYyli HTTP/1.1\\nHost: cavatica-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: 7942f56901534434a054dafc3813bc96\\\" -H \\\"content-type: application/json\\\" -X GET \\\"https://cavatica-api.sbgenomics.com/v2/upload/multipart\\\"\",\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 of the upload. It can be obtained by [initializing a new upload](doc:initialize-a-multipart-upload) or by [listing the ongoing multipart uploads](doc:list-current-multipart-uploads).\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n###Query parameters\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Datatype\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`list_parts`\",\n    \"0-1\": \"Boolean: `true` or `false`\",\n    \"0-2\": \"If `true`, also return a list of parts that have been reported as completed for this multipart upload.\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\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###Example response body\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"upload_id\\\": \\\"X5FXjV7JVCdg0cidZKIOOZRvAgahy9znuHq1PMsOZ85de6x53UOcJAcCDXANVTpm\\\",\\n  \\\"project\\\": \\\"RFranklin/my-project\\\",\\n  \\\"name\\\": \\\"1000G_omni2.5.b37.vcf\\\",\\n  \\\"initiated\\\": \\\"2016-01-01T00:00:00Z\\\",\\n  \\\"parallel_uploads\\\": true,\\n  \\\"part_size\\\": 1073741824,\\n  \\\"uploaded_parts_count\\\": 1,\\n  \\\"parts\\\": [\\n    {\\n      \\\"part_number\\\": 1,\\n      \\\"response\\\": {\\n        \\\"headers\\\": {\\n          \\\"ETag\\\": \\\"43a5e128440f2b6602badfdabe610f30\\\"\\n        }\\n      }\\n    }\\n  ]\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\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":"get-details-of-a-multipart-upload","type":"endpoint","title":"Get details of a multipart upload"}

getGet details of a multipart upload

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

This call will return the details of an active multipart upload. The upload is referenced by its ID as returned by a call to [initialize a multipart upload](doc:initialize-a-multipart-upload) or [list current multipart uploads](doc:list-current-multipart-uploads). [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": "GET /v2/upload/multipart/ezBaGmsWvyLwLjDdw3WNXXfs0EK4GpcHXijP37fP7o1jbdh24IAFEF7New5wYyli HTTP/1.1\nHost: cavatica-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\n", "language": "http", "name": null }, { "code": "curl -s -H \"X-SBG-Auth-Token: 7942f56901534434a054dafc3813bc96\" -H \"content-type: application/json\" -X GET \"https://cavatica-api.sbgenomics.com/v2/upload/multipart\"", "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 of the upload. It can be obtained by [initializing a new upload](doc:initialize-a-multipart-upload) or by [listing the ongoing multipart uploads](doc:list-current-multipart-uploads)." }, "cols": 2, "rows": 1 } [/block] ###Query parameters [block:parameters] { "data": { "h-0": "Name", "h-1": "Datatype", "h-2": "Description", "0-0": "`list_parts`", "0-1": "Boolean: `true` or `false`", "0-2": "If `true`, also return a list of parts that have been reported as completed for this multipart upload." }, "cols": 3, "rows": 1 } [/block] ##Response [See a list of Cavatica-specific response codes that may be contained in the body of the response.](doc:api-status-codes) ###Example response body [block:code] { "codes": [ { "code": "{\n \"upload_id\": \"X5FXjV7JVCdg0cidZKIOOZRvAgahy9znuHq1PMsOZ85de6x53UOcJAcCDXANVTpm\",\n \"project\": \"RFranklin/my-project\",\n \"name\": \"1000G_omni2.5.b37.vcf\",\n \"initiated\": \"2016-01-01T00:00:00Z\",\n \"parallel_uploads\": true,\n \"part_size\": 1073741824,\n \"uploaded_parts_count\": 1,\n \"parts\": [\n {\n \"part_number\": 1,\n \"response\": {\n \"headers\": {\n \"ETag\": \"43a5e128440f2b6602badfdabe610f30\"\n }\n }\n }\n ]\n}", "language": "json" } ], "sidebar": true } [/block] <div align="right"><a href="#top">top</a></div> <hr>