{"_id":"5b0e13ffc4664e0003c75c01","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"},"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"},"parentDoc":null,"project":"5b0e13ffc4664e0003c75a66","__v":0,"user":"5613e4f8fdd08f2b00437620","githubsync":"","metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-03-31T21:44:47.917Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","examples":{"codes":[]},"method":"post","auth":"required","params":[],"url":""},"isReference":true,"order":44,"body":"This call initializes a multipart file upload. \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://f4c-api.sbgenomics.com/v2/upload/multipart\",\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 HTTP/1.1\\nHost: f4c-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://f4c-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 [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    \"1-0\": \"`name`\\n*Required*\",\n    \"1-1\": \"String\",\n    \"2-0\": \"`size`\",\n    \"2-1\": \"Integer\",\n    \"3-1\": \"Integer\",\n    \"4-1\": \"String\",\n    \"3-0\": \"`part_size`\",\n    \"4-0\": \"`md5`\",\n    \"1-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    \"2-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    \"3-2\": \"The preferred size for upload parts. If omitted or set to a value that is incompatible with the cloud storage provider (AWS), a default value will be used.\",\n    \"4-2\": \"32-byte hexadecimal MD5 checksum of the file. This value is currently only stored but is not used by the Platform.\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\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\": \"{\\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]","excerpt":"/upload/multipart","slug":"initialize-a-multipart-upload","type":"endpoint","title":"Initialize a multipart upload"}

postInitialize a multipart upload

/upload/multipart

This call initializes a multipart file upload. [block:code] { "codes": [ { "code": "https://f4c-api.sbgenomics.com/v2/upload/multipart", "language": "text", "name": "Path" } ] } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "POST /v2/upload/multipart HTTP/1.1\nHost: f4c-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://f4c-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 [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.", "1-0": "`name`\n*Required*", "1-1": "String", "2-0": "`size`", "2-1": "Integer", "3-1": "Integer", "4-1": "String", "3-0": "`part_size`", "4-0": "`md5`", "1-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.", "2-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.", "3-2": "The preferred size for upload parts. If omitted or set to a value that is incompatible with the cloud storage provider (AWS), a default value will be used.", "4-2": "32-byte hexadecimal MD5 checksum of the file. This value is currently only stored but is not used by the Platform." }, "cols": 3, "rows": 5 } [/block] ##Response [See a list of 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]