{"_id":"5b0e13ffc4664e0003c75b2a","project":"5b0e13ffc4664e0003c75a66","user":"566590c83889610d0008a253","parentDoc":null,"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"},"category":{"_id":"5b0e13ffc4664e0003c75aa9","__v":0,"project":"5b0e13ffc4664e0003c75a66","version":"5b0e13ffc4664e0003c75a67","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-10-17T12:58:31.759Z","from_sync":false,"order":34,"slug":"folders-api-advance-access","title":"FOLDERS API (Advance Access)"},"__v":0,"githubsync":"","metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-10-17T13:08:44.931Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","results":{"codes":[]},"settings":"","examples":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":true,"order":3,"body":"[block:callout]\n{\n  \"type\": \"danger\",\n  \"body\": \"This page documents the Advance Access version (think \\\"beta\\\" but with fewer bugs) of the folders functionality.\",\n  \"title\": \"Heads Up!\"\n}\n[/block]\nThis call copies the specified file to another folder within the same project. Files retain their metadata when copied, but may be assigned new names in their target project.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://f4c-api.sbgenomics.com/v2/files/{file_id}/actions/copy\",\n      \"language\": \"text\",\n      \"name\": \"Path\"\n    }\n  ]\n}\n[/block]\n##Request\n###Example request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /v2/files/{file_id}/actions/copy HTTP/1.1\\nHost: f4c-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\\nContent-Type: application/json\\nX-SBG-advance-access: advance\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl --data '{\\\"project\\\": \\\"RFranklin/my-project\\\", \\\"name\\\": \\\"new-file\\\", \\\"parent: \\\"57fb98c51c94d72f08ba0544\\\"}'  -s -H \\\"X-SBG-Auth-Token: 7942f56901534434a054dafc3813bc96\\\" -H \\\"content-type: application/json\\\" -X POST \\\"https://f4c-api.sbgenomics.com/v2/files/568e69ade4b0307bc0464164/actions/copy\\\"\\n\",\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    \"2-0\": \"`X-SBG-Advance-Access`\\n*required* \",\n    \"2-1\": \"`advance`\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\n###Request body\nIn the request body, you should enter the following list of key-value pairs:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`parent`\\n*required* \",\n    \"0-1\": \"String\",\n    \"0-2\": \"Specifies the target folder by using its ID.\\nTo find out the folder ID, use the [List folder contents](doc:list-folder-contents) call for its parent folder.\",\n    \"1-0\": \"`name`\",\n    \"1-1\": \"String\",\n    \"1-2\": \"Specifies a new name for a file in case you want to rename it.\\nIf you want to use the same name, omit this key.\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n ###Example request body\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"parent\\\": \\\"57ff702e1c94d72f08ba34e8\\\", \\n  \\\"name\\\": \\\"1000G_omni2.5.hg38.vcf\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n##Response\n\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  \\\"href\\\": \\\"https://f4c-api.sbgenomics.com/v2/files/57fba0611c94d72f08ba0550\\\",\\n  \\\"id\\\": \\\"57ff71c71c94d72f08ba34ed\\\",\\n  \\\"name\\\": \\\"1000G_omni2.5.hg38.vcf\\\",\\n  \\\"size\\\": 208485995,\\n  \\\"project\\\": \\\"rfranklin/my-project-3\\\",\\n  \\\"parent\\\": \\\"57ff702e1c94d72f08ba34e8\\\",\\n  \\\"type\\\": \\\"FILE\\\",\\n  \\\"created_on\\\": \\\"2016-10-13T11:36:39Z\\\",\\n  \\\"modified_on\\\": \\\"2016-10-13T11:36:39Z\\\",\\n  \\\"storage\\\": {\\n    \\\"type\\\": \\\"PLATFORM\\\"\\n  },\\n  \\\"origin\\\": {},\\n  \\\"tags\\\": [\\n    \\\"WGS\\\",\\n    \\\"hg38\\\"\\n  ],\\n  \\\"metadata\\\": {}\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example response body\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"/files/{file_id}/actions/copy","slug":"copy-a-file-between-folders","type":"endpoint","title":"Copy a file between folders"}

postCopy a file between folders

/files/{file_id}/actions/copy

[block:callout] { "type": "danger", "body": "This page documents the Advance Access version (think \"beta\" but with fewer bugs) of the folders functionality.", "title": "Heads Up!" } [/block] This call copies the specified file to another folder within the same project. Files retain their metadata when copied, but may be assigned new names in their target project. [block:code] { "codes": [ { "code": "https://f4c-api.sbgenomics.com/v2/files/{file_id}/actions/copy", "language": "text", "name": "Path" } ] } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "POST /v2/files/{file_id}/actions/copy HTTP/1.1\nHost: f4c-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\nContent-Type: application/json\nX-SBG-advance-access: advance", "language": "http", "name": null }, { "code": "curl --data '{\"project\": \"RFranklin/my-project\", \"name\": \"new-file\", \"parent: \"57fb98c51c94d72f08ba0544\"}' -s -H \"X-SBG-Auth-Token: 7942f56901534434a054dafc3813bc96\" -H \"content-type: application/json\" -X POST \"https://f4c-api.sbgenomics.com/v2/files/568e69ade4b0307bc0464164/actions/copy\"\n", "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`", "2-0": "`X-SBG-Advance-Access`\n*required* ", "2-1": "`advance`" }, "cols": 2, "rows": 3 } [/block] ###Request body In the request body, you should enter the following list of key-value pairs: [block:parameters] { "data": { "h-0": "Name", "h-1": "Data type", "h-2": "Description", "0-0": "`parent`\n*required* ", "0-1": "String", "0-2": "Specifies the target folder by using its ID.\nTo find out the folder ID, use the [List folder contents](doc:list-folder-contents) call for its parent folder.", "1-0": "`name`", "1-1": "String", "1-2": "Specifies a new name for a file in case you want to rename it.\nIf you want to use the same name, omit this key." }, "cols": 3, "rows": 2 } [/block] ###Example request body [block:code] { "codes": [ { "code": "{\n \"parent\": \"57ff702e1c94d72f08ba34e8\", \n \"name\": \"1000G_omni2.5.hg38.vcf\"\n}", "language": "json" } ] } [/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 \"href\": \"https://f4c-api.sbgenomics.com/v2/files/57fba0611c94d72f08ba0550\",\n \"id\": \"57ff71c71c94d72f08ba34ed\",\n \"name\": \"1000G_omni2.5.hg38.vcf\",\n \"size\": 208485995,\n \"project\": \"rfranklin/my-project-3\",\n \"parent\": \"57ff702e1c94d72f08ba34e8\",\n \"type\": \"FILE\",\n \"created_on\": \"2016-10-13T11:36:39Z\",\n \"modified_on\": \"2016-10-13T11:36:39Z\",\n \"storage\": {\n \"type\": \"PLATFORM\"\n },\n \"origin\": {},\n \"tags\": [\n \"WGS\",\n \"hg38\"\n ],\n \"metadata\": {}\n}", "language": "json", "name": "Example response body" } ], "sidebar": true } [/block]