{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","method":"post","params":[],"results":{"codes":[]},"settings":"","examples":{"codes":[]}},"next":{"description":"","pages":[]},"title":"Move a file between folders","type":"endpoint","slug":"move-a-file-between-folders","excerpt":"/files","body":"This call moves a file from one folder to another. Moving of files is only allowed within the same project.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cavatica-api.sbgenomics.com/v2/files/{file_id}/actions/move\",\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/move HTTP/1.1\\nHost: cavatica-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\\nContent-Type: application/json\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl --data ':::at:::move.json' -X POST -H \\\"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\\\" -H \\\"Content-Type: application/json\\\" 'https://cavatica-api.sbgenomics.com/files'\",\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###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 response 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 \n\n##Response\n\n[See a list of Cavatica-specific response codes that may be contained in the body of the response.](doc:api-status-codes).","updates":[],"order":46,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5804dd5992398f0f00e77533","user":"566590c83889610d0008a253","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"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","5eaff69e844d67003642a020","5eb00899b36ba5002d35b0c1","5eb0172be179b70073dc936e","5eb01b42b36ba5002d35ebba","5eb01f202654a20136813093","5eb918ef149186021c9a76c8","5f0839d3f4b24e005ebbbc29"],"_id":"5773dcfc255e820e00e1cd50","__v":34,"createdAt":"2016-06-29T14:36:44.812Z","releaseDate":"2016-06-29T14:36:44.812Z","project":"5773dcfc255e820e00e1cd4d"},"__v":1,"project":"5773dcfc255e820e00e1cd4d","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Cavatica API","slug":"api","order":18,"from_sync":false,"reference":false,"_id":"5773df36904b0c0e00ef05ff","createdAt":"2016-06-29T14:46:14.277Z","version":"5773dcfc255e820e00e1cd50","__v":0,"project":"5773dcfc255e820e00e1cd4d"},"githubsync":"","createdAt":"2016-10-17T14:16:57.480Z","parentDoc":null}

postMove a file between folders

/files

This call moves a file from one folder to another. Moving of files is only allowed within the same project. [block:code] { "codes": [ { "code": "https://cavatica-api.sbgenomics.com/v2/files/{file_id}/actions/move", "language": "text", "name": "Path" } ] } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "POST /v2/files/{file_id}/actions/move HTTP/1.1\nHost: cavatica-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\nContent-Type: application/json", "language": "http", "name": null }, { "code": "curl --data '@move.json' -X POST -H \"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\" -H \"Content-Type: application/json\" 'https://cavatica-api.sbgenomics.com/files'", "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] ###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 response body [block:code] { "codes": [ { "code": "{\n \"parent\": \"57ff702e1c94d72f08ba34e8\", \n \"name\": \"1000G_omni2.5.hg38.vcf\"\n}", "language": "json" } ] } [/block] ##Response [See a list of Cavatica-specific response codes that may be contained in the body of the response.](doc:api-status-codes).