{"_id":"5774ece3cee322190018f5bf","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"},"githubsync":"","__v":3,"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"},"parentDoc":null,"project":"5773dcfc255e820e00e1cd4d","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-06-30T09:56:51.036Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"post","results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":52,"body":"This call initializes a multipart file upload. \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cavatica-api.sbgenomics.com/v2/upload/multipart\",\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 HTTP/1.1\\nHost: cavatica-api.sbgenomics.com\\nContent-Type: application/json\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\\n\\n{\\n  \\\"project\\\": \\\"RFranklin/my-project\\\",\\n  \\\"name\\\": \\\"CanFam3.1.dna_rm.toplevel.fa.gz\\\",\\n  \\\"part_size\\\": 5242880,\\n  \\\"size\\\": 433759572\\n}\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl --data '{\\\"project\\\": \\\"RFranklin/my-project\\\", \\\"name\\\": \\\"CanFam3.1.dna_rm.toplevel.fa.gz\\\", \\\"part_size\\\": 5242880, \\\"size\\\": 433759572}' -s -H \\\"X-SBG-Auth-Token: 7942f56901534434a054dafc3813bc96\\\" -H \\\"content-type: application/json\\\" -X POST \\\"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###Query parameters\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Datatype\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`overwrite`\",\n    \"0-1\": \"Boolean: `true` or `false`\",\n    \"0-2\": \"If `overwrite` is set to `true` and a file already exists under the name specified in the request, the existing file will be deleted and a new one created in its place.\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n###Request body\nIn the body, you should enter a list of key-value pairs. The keys, and the values they take, are described in the following table.\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\": \"`project`\\n*Required*\",\n    \"0-1\": \"String\",\n    \"0-2\": \"The name of the project you want to upload a file to.\",\n    \"2-0\": \"`name`\\n*Required*\",\n    \"2-1\": \"String\",\n    \"3-0\": \"`size`\",\n    \"3-1\": \"Integer\",\n    \"4-1\": \"Integer\",\n    \"5-1\": \"String\",\n    \"4-0\": \"`part_size`\",\n    \"5-0\": \"`md5`\",\n    \"2-2\": \"The name of the file you are about to upload. This must be unique in the project, unless you are also enabling the `overwrite` query parameter.\\n\\nAllowed characters in **file names** are all alphanumerics and special characters except slash (`/`). File names can’t be longer than 255 characters.\",\n    \"3-2\": \"The size of the file that will be uploaded. This can be used to track progress of an ongoing upload, but is otherwise optional.\",\n    \"4-2\": \"The preferred size for upload parts. If omitted or set to a value that is incompatible with the cloud storage provider, a default value will be used.\",\n    \"5-2\": \"32-byte hexadecimal MD5 checksum of the file. This value is currently only stored but is not used by the Platform.\",\n    \"1-2\": \"The ID of the folder to which the item is being uploaded.\\n\\nShould not be used together with `project`. If `parent` is used, the upload will take place into the specified folder, within the project to which the folder belongs. If `project` is used, the items will be imported to the root of the project's files.\",\n    \"1-0\": \"`parent`\",\n    \"1-1\": \"String\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\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  \\\"project\\\": \\\"RFranklin/my-project\\\",\\n  \\\"name\\\": \\\"CanFam3.1.dna_rm.toplevel.fa.gz\\\",\\n  \\\"size\\\": 433759572,\\n  \\\"upload_id\\\": \\\"oSZ5rOjMQa34UykB4FiPdhkCalLVrcQjxjKPkAT69skWgOPlOvcvGaqEJ7SI1o4w\\\",\\n  \\\"part_size\\\": 5242880,\\n  \\\"parallel_uploads\\\": true\\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\n\nFor general information on the API, including formatting, parameters, and pagination, please see the [API Overview](the-api).","slug":"initialize-a-multipart-upload","type":"endpoint","title":"Initialize a multipart upload"}

postInitialize a multipart upload

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

This call initializes a multipart file upload. [block:code] { "codes": [ { "code": "https://cavatica-api.sbgenomics.com/v2/upload/multipart", "language": "text", "name": "API path" } ] } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "POST /v2/upload/multipart HTTP/1.1\nHost: cavatica-api.sbgenomics.com\nContent-Type: application/json\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\n\n{\n \"project\": \"RFranklin/my-project\",\n \"name\": \"CanFam3.1.dna_rm.toplevel.fa.gz\",\n \"part_size\": 5242880,\n \"size\": 433759572\n}", "language": "http", "name": null }, { "code": "curl --data '{\"project\": \"RFranklin/my-project\", \"name\": \"CanFam3.1.dna_rm.toplevel.fa.gz\", \"part_size\": 5242880, \"size\": 433759572}' -s -H \"X-SBG-Auth-Token: 7942f56901534434a054dafc3813bc96\" -H \"content-type: application/json\" -X POST \"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] ###Query parameters [block:parameters] { "data": { "h-0": "Name", "h-1": "Datatype", "h-2": "Description", "0-0": "`overwrite`", "0-1": "Boolean: `true` or `false`", "0-2": "If `overwrite` is set to `true` and a file already exists under the name specified in the request, the existing file will be deleted and a new one created in its place." }, "cols": 3, "rows": 1 } [/block] ###Request body In the body, you should enter a list of key-value pairs. The keys, and the values they take, are described in the following table. [block:parameters] { "data": { "h-0": "Key", "h-1": "Datatype of value", "h-2": "Description of value", "0-0": "`project`\n*Required*", "0-1": "String", "0-2": "The name of the project you want to upload a file to.", "2-0": "`name`\n*Required*", "2-1": "String", "3-0": "`size`", "3-1": "Integer", "4-1": "Integer", "5-1": "String", "4-0": "`part_size`", "5-0": "`md5`", "2-2": "The name of the file you are about to upload. This must be unique in the project, unless you are also enabling the `overwrite` query parameter.\n\nAllowed characters in **file names** are all alphanumerics and special characters except slash (`/`). File names can’t be longer than 255 characters.", "3-2": "The size of the file that will be uploaded. This can be used to track progress of an ongoing upload, but is otherwise optional.", "4-2": "The preferred size for upload parts. If omitted or set to a value that is incompatible with the cloud storage provider, a default value will be used.", "5-2": "32-byte hexadecimal MD5 checksum of the file. This value is currently only stored but is not used by the Platform.", "1-2": "The ID of the folder to which the item is being uploaded.\n\nShould not be used together with `project`. If `parent` is used, the upload will take place into the specified folder, within the project to which the folder belongs. If `project` is used, the items will be imported to the root of the project's files.", "1-0": "`parent`", "1-1": "String" }, "cols": 3, "rows": 6 } [/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 \"project\": \"RFranklin/my-project\",\n \"name\": \"CanFam3.1.dna_rm.toplevel.fa.gz\",\n \"size\": 433759572,\n \"upload_id\": \"oSZ5rOjMQa34UykB4FiPdhkCalLVrcQjxjKPkAT69skWgOPlOvcvGaqEJ7SI1o4w\",\n \"part_size\": 5242880,\n \"parallel_uploads\": true\n}", "language": "json" } ], "sidebar": true } [/block] <div align="right"><a href="#top">top</a></div> <hr>