{"_id":"5774e99acee322190018f5b6","parentDoc":null,"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":"","user":"575e85ac41c8ba0e00259a44","project":"5773dcfc255e820e00e1cd4d","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"},"__v":3,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-06-30T09:42:50.815Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"post","results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":37,"body":"This call copies the specified file to a new project. Files retain their metadata when copied, but may be assigned new names in their target project.\n\nTo make this call, you should have [copy permission](doc:set-permissions) within the project you are copying from.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cavatica-api.sbgenomics.com/v2/files/{file_id}/actions/copy\",\n      \"language\": \"text\",\n      \"name\": \"API path\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"success\",\n  \"body\": \"Recall from the [API Overview](doc:the-api#section-identifying-projects-users-apps-files-tasks-and-inputs) that the `file_id` is a hexadecimal string.\\n\\nYou can get the `file_id` for an file by making the call to [list files within a specified project (primary method)](doc:list-files-primary-method)\",\n  \"title\": \"file_ids\"\n}\n[/block]\n##Request\n\n###Example request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST v2/files/568e69ade4b0307bc0464164/actions/copy HTTP/1.1\\nHost: cavatica-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\\n\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl --data '{\\\"project\\\": \\\"RFranklin/my-project\\\", \\\"name\\\": \\\"new-file\\\"}'  -s -H \\\"X-SBG-Auth-Token: 7942f56901534434a054dafc3813bc96\\\" -H \\\"content-type: application/json\\\" -X POST \\\"https://cavatica-api.sbgenomics.com/v2/files/568e69ade4b0307bc0464164/actions/copy\\\" \",\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  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n###Path parameters\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`file_id`\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-1\": \"The ID for the file you are querying. It can be obtained by making the call to [list your files (primary method)](doc:list-files-primary-method).\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n###Query parameters\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`fields`\",\n    \"0-1\": \"string\",\n    \"0-2\": \"Selector specifying a subset of fields to include in the response.\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n##Request body\nThe body should contain the following key-value pairs:\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    \"1-0\": \"`\\\"name\\\"`\",\n    \"1-1\": \"string\",\n    \"0-2\": \"The name of the project you want to copy the file to\",\n    \"1-2\": \"The new name the file will have in the target project.\\nIf its name will not change, 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  \\\"project\\\": \\\"RFranklin/my-project\\\", \\n  \\\"name\\\": \\\"new-file\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\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) \n\n###Example response body\nThe response gives the full specification of the file, and its metadata.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/files/569637cce4b0b65fcb306ae5\\\",\\n  \\\"id\\\": \\\"569637cce4b0b65fcb306ae5\\\",\\n  \\\"name\\\": \\\"new-file\\\",\\n  \\\"size\\\": 68425,\\n  \\\"project\\\": \\\"RFranklin/my-project\\\",\\n  \\\"created_on\\\": \\\"2016-01-13T11:41:00Z\\\",\\n  \\\"modified_on\\\": \\\"2016-01-13T11:41:00Z\\\",\\n  \\\"origin\\\": {},\\n  \\\"metadata\\\": {\\n\\t  \\\"sample_id\\\": \\\"E16201_pool35_L1756\\\",\\n \\t  \\\"library_id\\\": \\\"hg19\\\",\\n\\t  \\\"platform_unit_id\\\": \\\"C18_99\\\",\\n\\t  \\\"platform\\\": \\\"IonTorrent\\\",\\n\\t  \\\"quality_scale\\\": \\\"sanger\\\"\\n\\t}\\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":"/v2/files/{file_id}/actions/copy\n\nFor general information on the API, including formatting, parameters, and pagination, please see the [API Overview](the-api).","slug":"copy-a-file","type":"endpoint","title":"Copy a file between projects"}

postCopy a file between projects

/v2/files/{file_id}/actions/copy For general information on the API, including formatting, parameters, and pagination, please see the [API Overview](the-api).

This call copies the specified file to a new project. Files retain their metadata when copied, but may be assigned new names in their target project. To make this call, you should have [copy permission](doc:set-permissions) within the project you are copying from. [block:code] { "codes": [ { "code": "https://cavatica-api.sbgenomics.com/v2/files/{file_id}/actions/copy", "language": "text", "name": "API path" } ] } [/block] [block:callout] { "type": "success", "body": "Recall from the [API Overview](doc:the-api#section-identifying-projects-users-apps-files-tasks-and-inputs) that the `file_id` is a hexadecimal string.\n\nYou can get the `file_id` for an file by making the call to [list files within a specified project (primary method)](doc:list-files-primary-method)", "title": "file_ids" } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "POST v2/files/568e69ade4b0307bc0464164/actions/copy HTTP/1.1\nHost: cavatica-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\n", "language": "http", "name": null }, { "code": "curl --data '{\"project\": \"RFranklin/my-project\", \"name\": \"new-file\"}' -s -H \"X-SBG-Auth-Token: 7942f56901534434a054dafc3813bc96\" -H \"content-type: application/json\" -X POST \"https://cavatica-api.sbgenomics.com/v2/files/568e69ade4b0307bc0464164/actions/copy\" ", "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": "" }, "cols": 2, "rows": 1 } [/block] ###Path parameters [block:parameters] { "data": { "0-0": "`file_id`", "h-0": "Name", "h-1": "Description", "0-1": "The ID for the file you are querying. It can be obtained by making the call to [list your files (primary method)](doc:list-files-primary-method)." }, "cols": 2, "rows": 1 } [/block] ###Query parameters [block:parameters] { "data": { "h-0": "Name", "h-1": "Data type", "h-2": "Description", "0-0": "`fields`", "0-1": "string", "0-2": "Selector specifying a subset of fields to include in the response." }, "cols": 3, "rows": 1 } [/block] ##Request body The body should contain the following key-value pairs: [block:parameters] { "data": { "h-0": "Key", "h-1": "Datatype of value", "h-2": "Description of value", "0-0": "`\"project\"`\n_required_", "0-1": "string", "1-0": "`\"name\"`", "1-1": "string", "0-2": "The name of the project you want to copy the file to", "1-2": "The new name the file will have in the target project.\nIf its name will not change, omit this key." }, "cols": 3, "rows": 2 } [/block] ###Example request body [block:code] { "codes": [ { "code": "{\n \"project\": \"RFranklin/my-project\", \n \"name\": \"new-file\"\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) ###Example response body The response gives the full specification of the file, and its metadata. [block:code] { "codes": [ { "code": "{\n \"href\": \"https://cavatica-api.sbgenomics.com/v2/files/569637cce4b0b65fcb306ae5\",\n \"id\": \"569637cce4b0b65fcb306ae5\",\n \"name\": \"new-file\",\n \"size\": 68425,\n \"project\": \"RFranklin/my-project\",\n \"created_on\": \"2016-01-13T11:41:00Z\",\n \"modified_on\": \"2016-01-13T11:41:00Z\",\n \"origin\": {},\n \"metadata\": {\n\t \"sample_id\": \"E16201_pool35_L1756\",\n \t \"library_id\": \"hg19\",\n\t \"platform_unit_id\": \"C18_99\",\n\t \"platform\": \"IonTorrent\",\n\t \"quality_scale\": \"sanger\"\n\t}\n}", "language": "json" } ], "sidebar": true } [/block] <div align="right"><a href="#top">top</a></div> <hr>