{"_id":"5b0e13ffc4664e0003c75b29","project":"5b0e13ffc4664e0003c75a66","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"},"__v":0,"parentDoc":null,"user":"554340dfb7f4540d00fcef1d","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"},"githubsync":"","metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-13T11:49:12.532Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","results":{"codes":[]},"settings":"","examples":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":true,"order":34,"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\nNote that Controlled Data files may not be copied to [Open Data projects](doc:projects-on-the-platform). To 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://f4c-api.sbgenomics.com/v2/files/{file_id}/actions/copy\",\n      \"language\": \"text\",\n      \"name\": \"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-and-tasks) 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-in-a-project)\",\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: f4c-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://f4c-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 [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-in-a-project).\"\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. If 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 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://f4c-api.sbgenomics.com/v2/files/5d9f0b7de4b09e9dcb8d160c\\\",\\n    \\\"id\\\": \\\"5d9f0b7de4b09e9dcb8d160c\\\",\\n    \\\"name\\\": \\\"new-file\\\",\\n    \\\"size\\\": 5,\\n    \\\"project\\\": \\\"rfranklin/my-project\\\",\\n    \\\"parent\\\": \\\"5d4ad1b1e4b05e2cb95903ec\\\",\\n    \\\"type\\\": \\\"file\\\",\\n    \\\"created_on\\\": \\\"2019-10-10T10:44:13Z\\\",\\n    \\\"modified_on\\\": \\\"2019-10-10T10:44:13Z\\\",\\n    \\\"storage\\\": {\\n        \\\"type\\\": \\\"PLATFORM\\\",\\n        \\\"hosted_on_locations\\\": [\\n            \\\"aws:us-east-1\\\",\\n            \\\"google:us-west1\\\"\\n        ]\\n    },\\n    \\\"origin\\\": {},\\n    \\\"tags\\\": [\\n        \\\"TEST\\\"\\n    ],\\n    \\\"metadata\\\": {\\n        \\\"md5_sum\\\": \\\"3feb601b4b6d63db86669175f921463b\\\",\\n        \\\"sbg_public_files_category\\\": \\\"reference\\\"\\n    }\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"/v2/files/{file_id}/actions/copy","slug":"copy-a-file","type":"endpoint","title":"Copy a file"}

postCopy a file

/v2/files/{file_id}/actions/copy

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. Note that Controlled Data files may not be copied to [Open Data projects](doc:projects-on-the-platform). To make this call, you should have [copy permission](doc:set-permissions) within the project you are copying from. [block:code] { "codes": [ { "code": "https://f4c-api.sbgenomics.com/v2/files/{file_id}/actions/copy", "language": "text", "name": "Path" } ] } [/block] [block:callout] { "type": "success", "body": "Recall from the [API Overview](doc:the-api#section-identifying-projects-users-apps-files-and-tasks) 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-in-a-project)", "title": "file_ids" } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "POST v2/files/568e69ade4b0307bc0464164/actions/copy HTTP/1.1\nHost: f4c-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://f4c-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 [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-in-a-project)." }, "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. If 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 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://f4c-api.sbgenomics.com/v2/files/5d9f0b7de4b09e9dcb8d160c\",\n \"id\": \"5d9f0b7de4b09e9dcb8d160c\",\n \"name\": \"new-file\",\n \"size\": 5,\n \"project\": \"rfranklin/my-project\",\n \"parent\": \"5d4ad1b1e4b05e2cb95903ec\",\n \"type\": \"file\",\n \"created_on\": \"2019-10-10T10:44:13Z\",\n \"modified_on\": \"2019-10-10T10:44:13Z\",\n \"storage\": {\n \"type\": \"PLATFORM\",\n \"hosted_on_locations\": [\n \"aws:us-east-1\",\n \"google:us-west1\"\n ]\n },\n \"origin\": {},\n \"tags\": [\n \"TEST\"\n ],\n \"metadata\": {\n \"md5_sum\": \"3feb601b4b6d63db86669175f921463b\",\n \"sbg_public_files_category\": \"reference\"\n }\n}", "language": "json" } ], "sidebar": true } [/block]