{"__v":1,"_id":"5804cd5cd1b3990f00208981","category":{"project":"55faf11ba62ba1170021a9a7","version":"55faf11ba62ba1170021a9aa","_id":"5804caf792398f0f00e77521","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-10-17T12:58:31.759Z","from_sync":false,"order":30,"slug":"folders-api-advance-access","title":"FOLDERS API (Advance Access)"},"parentDoc":null,"project":"55faf11ba62ba1170021a9a7","user":"566590c83889610d0008a253","version":{"__v":37,"_id":"55faf11ba62ba1170021a9aa","project":"55faf11ba62ba1170021a9a7","createdAt":"2015-09-17T16:58:03.490Z","releaseDate":"2015-09-17T16:58:03.490Z","categories":["55faf11ca62ba1170021a9ab","55faf8f4d0e22017005b8272","55faf91aa62ba1170021a9b5","55faf929a8a7770d00c2c0bd","55faf932a8a7770d00c2c0bf","55faf94b17b9d00d00969f47","55faf958d0e22017005b8274","55faf95fa8a7770d00c2c0c0","55faf96917b9d00d00969f48","55faf970a8a7770d00c2c0c1","55faf98c825d5f19001fa3a6","55faf99aa62ba1170021a9b8","55faf99fa62ba1170021a9b9","55faf9aa17b9d00d00969f49","55faf9b6a8a7770d00c2c0c3","55faf9bda62ba1170021a9ba","5604570090ee490d00440551","5637e8b2fbe1c50d008cb078","5649bb624fa1460d00780add","5671974d1b6b730d008b4823","5671979d60c8e70d006c9760","568e8eef70ca1f0d0035808e","56d0a2081ecc471500f1795e","56d4a0adde40c70b00823ea3","56d96b03dd90610b00270849","56fbb83d8f21c817002af880","573c811bee2b3b2200422be1","576bc92afb62dd20001cda85","5771811e27a5c20e00030dcd","5785191af3a10c0e009b75b0","57bdf84d5d48411900cd8dc0","57ff5c5dc135231700aed806","5804caf792398f0f00e77521","58458b4fba4f1c0f009692bb","586d3c287c6b5b2300c05055","58ef66d88646742f009a0216","58f5d52d7891630f00fe4e77"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-10-17T13:08:44.931Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"post","results":{"codes":[]},"settings":"","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://cgc-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: cgc-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://cgc-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 CGC [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 CGC-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  \\\"href\\\": \\\"https://cgc-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://cgc-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: cgc-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://cgc-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 CGC [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 CGC-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 \"href\": \"https://cgc-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]